From e28eccb6fbf6e773d74110989da4658fb0619188 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Fri, 28 May 2021 10:29:59 +0100 Subject: [PATCH 1/2] README: Call out `npm run build` alternative in developer instructions --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8df06d13..89c49dda 100755 --- a/README.md +++ b/README.md @@ -27,6 +27,10 @@ To get a local instance of coriolis running, perform the following steps in a sh You will then have a development server running on `localhost:3300`. +Alternatively, instead of `npm start` you can run `npm run build` +after the `npm install` step and then enable web server access to the +`build/` directory, or copy it somewhere that is served. + ### Ship and Module Database See the [Data wiki](https://github.com/cmmcleod/coriolis-data/wiki) for details on structure, etc. From fd009fe567ed70eb9f33ef24f2b99f73dd1af268 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Fri, 28 May 2021 11:41:04 +0100 Subject: [PATCH 2/2] README: Make a 'Deployment' section and move instructions there. --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 89c49dda..7aeb37d5 100755 --- a/README.md +++ b/README.md @@ -27,10 +27,22 @@ To get a local instance of coriolis running, perform the following steps in a sh You will then have a development server running on `localhost:3300`. -Alternatively, instead of `npm start` you can run `npm run build` -after the `npm install` step and then enable web server access to the -`build/` directory, or copy it somewhere that is served. - ### Ship and Module Database See the [Data wiki](https://github.com/cmmcleod/coriolis-data/wiki) for details on structure, etc. + +## Deployment + +Follow the steps for [Development](#development) as above, but instead +of `npm start` you'll want to: + +```sh +> npm run build +``` + +this will result in a `build/` directory being created containing all the necessary files. + +After this you need to serve the files in some manner. +Either configure your webserver to make the actual `build/` directory +visible on the web, or alternatively copy it to somewhere to serve it +from.