Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to fix development instructions #80

Merged
merged 2 commits into from
Jan 23, 2024
Merged

Update README to fix development instructions #80

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
424b218
Update README to fix development instructions
MattIPv4 Jan 22, 2024
d7c1fb0
Update README.md
MattIPv4 Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@ Custom Vue templates & resources for DigitalOcean Community tools.

## Development

To setup the develop environment, you will need to run `npm i` with Node 12+ installed.
This will install the dependencies to allow you to work the project.
To setup the develop environment, you will need to have Node.js installed (matching the version specified in
`.nvmrc`), and then run `npm ci` to install dependencies (this will respect the lockfile).

We make use of `eslint` to maintain code quality in the JS & Vue files.
To run this you can use `npm test`.

A demo project is included in the `demo` directory, which helps ensure the Webpack config is working as expected.
This can be run with `demo:dev` to start a server with hot reloading, or `demo:build` to build the demo project.

## Usage Example

This package is being used in the [DigitalOcean Community DNS tools](https://github.com/do-community/dns-tool),
Expand All @@ -30,7 +33,7 @@ This directory contains internationalisation data for all the Vue templates in t
### [`src/templates`](./src/templates)

This directory contains all the centralised Vue templates we use for the Community tools.

### [`src/utils`](./src/utils)

This directory contains any shared utility scripts used in this package or the Community tools.
Expand Down