diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4cee93838..3ec230285 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ Other processes and specifications that are in use in this repository are: Ensure you have all prerequisites installed (including any optional ones), as noted in the [prerequisites section of the readme file](./README.md#prerequisites). -With those in place, you can fork the repository, clone it, and then run `npm install` to install all dependencies. +With those in place, you can fork the repository, clone it, and then run `npm i` to install all dependencies. Make a copy of `.env.template` in the root directory and rename it to `.env`, configuring the environment variables in the file as required. ### Development Workflow diff --git a/README.md b/README.md index d176cac66..856aca8ea 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Perform the following steps before deployment: ### Standard Deployment -1. Run `npm install --ignore-scripts --production` to install dependencies +1. Run `npm i --ignore-scripts --production` to install dependencies 2. Run `npm start` The service should be up and running on the port set in the config. You should see output similar to the following in stdout or in the log file specified using the `LOG_ROTATION_FILENAME` environment variable: @@ -86,8 +86,8 @@ This requires [Docker](https://www.docker.com) installed. If you are unable to deploy this into production using Docker, it is recommended that you use a process manager such as [PM2](https://pm2.keymetrics.io/). -1. Run `npm install --ignore-scripts --production` to install dependencies -2. Run `npm install -g pm2` to install pm2 globally +1. Run `npm i --ignore-scripts --production` to install dependencies +2. Run `npm i -g pm2` to install pm2 globally 3. Launch application with `pm2 start .pm2.config.js` 4. Check the application has been deployed using `pm2 list` or `pm2 monit`