diff --git a/README.md b/README.md index 5b1d078..888ea39 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,9 @@ All steps described here are working with a Debian based Linux system Run the installation script located in the docs folder: - ./docs/opt-cc-environment/3rd-party-install.sh +```text +./docs/opt-cc-environment/3rd-party-install.sh +``` It installs NPM, Node and MongoDB on latest versions. In addition, it sets up the mongo deamon to start up automatically with the system. @@ -25,7 +27,9 @@ In addition, it sets up the mongo deamon to start up automatically with the syst For production setup run the script, described in _Setup for development_, adding the parameter `prod` - ./docs/opt-cc-environment/3rd-party-install.sh prod +```text +./docs/opt-cc-environment/3rd-party-install.sh prod +``` This adds the [`pm2` process manager](http://pm2.keymetrics.io/) to be installed and start the _opt-cc_ server as `pm2` process. Run the `sudo` command printed as last output to configure the `pm2` process for automatic start on the system. @@ -37,19 +41,25 @@ Run the `sudo` command printed as last output to configure the `pm2` process for Before triggering the environment execution run - npm install +```text +npm install +``` inside the main folder, to process all needed npm package installations for the program execution. To compile the Angular code and afterwards start the Express server with `nodemon` for development purpose run - npm run dev +```text +npm run dev +``` Any changes on `api` code will trigger an automatic restart of the Express server. Changes on `static` code can be submitted with - npm run deploy-static +```text +npm run deploy-static +``` The page must be reloaded after this build step is finished, in order to make changes visible.