You need the following dependencies:
- Node.js version 8 or higher
- Redis server version 3 or higher
- Yarn
Installation:
- Download the code.
- Install the Node packages (run this in a console):
yarn install
- Copy the environment configuration:
cp example.env .env
- Setup the configuration in the
.env
file (usually the default configuration is fine).
Starting the application in the development mode:
- Start a Redis server (e.g. by running
redis-server
in a console). yarn dev
Starting the application in the production mode:
yarn build
(you need to do it only once after each code update).- Start a Redis server (e.g. by running
redis-server
in a console). yarn start
When the application is started, open http://localhost:3001 or http://localhost:3001/promo in a browser.
Architecture documentation: https://docs.google.com/document/d/1jr9OcKldhq58CRmS8Wz396kFjGgcic7rZa5R3hoaaGA
Low-level documentation:
- open
/out/index.html
in browser to access JSDoc documentation for the frontend app. yarn generate-docs
command to re-generate docs in your local machine./out
folder contains the html and css files are generated. These files use the comments written in the sourcecode and present all of them in one presentable place.- Please see http://usejsdoc.org/, for all the available tags we can use while writing JSdocs.