diff --git a/README.md b/README.md index 3f0f9ea..2e9b361 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,33 @@ -# website +# Website service -a [Sails v1](https://sailsjs.com) application +The website of The First Spine. A [Sails v1](https://sailsjs.com) application. +## Installation -### Links +``` +npm ci +``` -+ [Sails framework documentation](https://sailsjs.com/get-started) -+ [Version notes / upgrading](https://sailsjs.com/documentation/upgrading) -+ [Deployment tips](https://sailsjs.com/documentation/concepts/deployment) -+ [Community support options](https://sailsjs.com/support) -+ [Professional / enterprise options](https://sailsjs.com/enterprise) +## Running the app +Prefer using the Sails CLI (`npm install sails -g`) to start the application. -### Version info +``` +sails lift +``` -This app was originally generated on Wed Jan 22 2020 08:34:00 GMT+0100 (Paris, Madrid) using Sails v1.2.3. +## Build & run for production - +``` +npm run start +``` +## Configuration +See the configuration keys with the [Ansible playbook](https://github.com/thefirstspine/ansible/blob/master/volume/playbooks/deploy-website.yaml) - +To help you configure your local environment to generate a dotenv file you can use the [configurator](https://github.com/thefirstspine/configurator) using this command: +``` +node configurator.js create website --conf-path [local copy of ansible volume]/conf --force-http true +```