- clone this repo;
- run
yarn
ornpm i
- check out
.env
file for database connection settings - run
npm start
to start the backend. Don't close the shell ;)
- cd to
ui
folder - run
yarn
ornpm i
- check out
.env
file for backend connection settings - if you get any issues with node-sass bindings, get the correct lib for your platform from https://github.com/sass/node-sass/releases
- run
npm start
to start the frontend - keep calm while it's being compiled ;)
controllers
- app controllers ;)routes
- routers theremodels
- models forsequelize
db
- db interfacelib
- app level logicservices
- third-party services stuffui
- frontend sources
There are environment settings which aren't part of the codebase. Example:
NRICH_API_PORT=3001
NRICH_DB_HOST=localhost
NRICH_DB_DATABASE=nrich
NRICH_DB_USER=nrich
NRICH_DB_PASS=nrich
NRICH_DB_TIMEOUT=5000
NRICH_DB_DEBUG=true