From 9ab699a2b89df243828c89435515bdb83f680336 Mon Sep 17 00:00:00 2001 From: Matt Cowley Date: Tue, 23 Jan 2024 01:52:09 +0000 Subject: [PATCH] Update README to fix development instructions (#80) Co-authored-by: David Carlson Berg --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eaa5cdbd..9891daf4 100644 --- a/README.md +++ b/README.md @@ -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), @@ -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.