| 1 | [](https://travis-ci.org/garage-it/SmartHouse-backend)
|
| 2 | [](https://codecov.io/github/garage-it/SmartHouse-backend?branch=master)
|
| 3 | [](https://david-dm.org/garage-it/SmartHouse-backend)
|
| 4 | [](https://david-dm.org/garage-it/SmartHouse-backend?type=dev)
|
| 5 | [](https://badge.fury.io/js/smart-house-backend)
|
| 6 |
|
| 7 | ## Commands
|
| 8 |
|
| 9 | Install dependencies:
|
| 10 | ```sh
|
| 11 | npm install
|
| 12 | ```
|
| 13 |
|
| 14 | ### Start server:
|
| 15 | ```sh
|
| 16 | # set DEBUG env variable to get debug logs
|
| 17 | DEBUG=express-mongoose-es6-rest-api:* npm start
|
| 18 |
|
| 19 | # or without debug
|
| 20 | npm start
|
| 21 | ```
|
| 22 |
|
| 23 | ### Start server in production mode:
|
| 24 | ```sh
|
| 25 | # will run api backend
|
| 26 | npm run api
|
| 27 | ```
|
| 28 |
|
| 29 | ### Execute tests:
|
| 30 |
|
| 31 | ```sh
|
| 32 | # run unit and integration tests
|
| 33 | npm test
|
| 34 | ```
|
| 35 |
|
| 36 | ```sh
|
| 37 | # run all tests with coverage
|
| 38 | npm run test-coverage
|
| 39 | ```
|
| 40 |
|
| 41 | ```sh
|
| 42 | # run only unit tests
|
| 43 | npm run test:unit
|
| 44 |
|
| 45 | # watch mode
|
| 46 | npm run test-watch:unit
|
| 47 | ```
|
| 48 |
|
| 49 | ```sh
|
| 50 | # run only integration tests
|
| 51 | npm run test:integration
|
| 52 |
|
| 53 | # watch mode
|
| 54 | npm run test-watch:integration
|
| 55 | ```
|
| 56 |
|
| 57 |
|
| 58 | ### Other tasks:
|
| 59 | ```sh
|
| 60 | # Lint code with ESLint
|
| 61 | npm run lint
|
| 62 | ```
|
| 63 |
|
| 64 | ## Logging
|
| 65 |
|
| 66 | Universal logging library [winston](https://www.npmjs.com/package/winston) is used for logging. It has support for multiple transports. A transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file. We just log to the console for simplicity, you can configure more transports as per your requirement.
|
| 67 |
|
| 68 | #### API logging
|
| 69 | Logs detailed info about each api request to console during development.
|
| 70 | 
|
| 71 |
|
| 72 | #### Error logging
|
| 73 | Logs stacktrace of error to console along with other details. You should ideally store all error messages persistently.
|
| 74 | 
|
| 75 |
|
| 76 | ## Code Coverage
|
| 77 | Get code coverage summary on executing `npm test`
|
| 78 | 
|
| 79 |
|
| 80 | `npm test` also generates HTML code coverage report in `coverage/` directory. Open `lcov-report/index.html` to view it.
|
| 81 | 
|