Backend for Reading List app

Development

Setup environment

1. Install Node.js
2. Install Angular CLI:

$ yarn global add gulp

or (alternative)

$ npm install -g gulp

3. Install dependencies:

$ yarn

or (alternative)

$ npm install

Usage

Run app on local:

$ gulp

Run compile typescript, lint and tests as watcher (useful to keep in separate terminal window while development):

$ gulp watch

Run lint and tests:

$ gulp build-and-validate

Production/staging environment

Setup environment

1. Install Node.js
2. Install PM2:

$ yarn global add pm2

or (alternative)

$ npm install -g pm2

3. Install dependencies:

$ yarn

or (alternative)

$ npm install

Usage

To start app:

$ pm2 start pm2.production.json

Contributing

Unit tests

All js code should be unit-tested

Code style

https://github.com/felixge/node-style-guide

https://basarat.gitbooks.io/typescript/content/docs/styleguide/styleguide.html

Commits & Pull requests

Commits should follow guidelines. Short version:

• no commits to master: only Pull Requests from feature branches
• code have to be linted and tested

Check commit message conventions