Skip to content

Commit

Permalink
Merge branch 'master' into MattIPv4/fix-external-link
Browse files Browse the repository at this point in the history
  • Loading branch information
MattIPv4 authored Jan 23, 2024
2 parents dc42df7 + 9ab699a commit e106e64
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
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

1 comment on commit e106e64

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit has been deployed to DigitalOcean Spaces for easy reviewing.

do-vue (Build Analysis Report)

Please sign in to comment.