- Install NodeJS, MongoDB, Redis for your system (without redis this wont work)
- Install
npmoryarn - Rename
.env.exampleto.env - Start MongoDB
- Run
yarn run devornpm run dev - Check
http://localhost:3000/api/statusto see it works - To build docs run
npm run apidoc - To test app run
npm run test
gulp is a task runner, so we have automated everything with it
- Install gulp globally with
npm install -g gulp-cli - Run
npm installoryarnon project root - Run
gulpto start server on your port - Run
gulp watchto automatically lint your code and build APIDocs on demand - Make sure you run these tasks in separate terminals
- To test your code run
gulp test - To lint your code run
gulp lint - To build docs run
gulp apidoc
- Visit HOST:PORT/docs