Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smoke-trees/nodejs-backend-template
Standardized template for SmokeTrees node.js projects.
https://github.com/smoke-trees/nodejs-backend-template
coverage nodejs template testing
Last synced: about 2 months ago
JSON representation
Standardized template for SmokeTrees node.js projects.
- Host: GitHub
- URL: https://github.com/smoke-trees/nodejs-backend-template
- Owner: smoke-trees
- License: mit
- Created: 2020-03-21T07:20:28.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:00:26.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T14:24:02.840Z (almost 2 years ago)
- Topics: coverage, nodejs, template, testing
- Language: JavaScript
- Homepage:
- Size: 1.59 MB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Template by SmokeTrees
Standard template used at SmokeTrees for REST APIs written in NodeJS.
[](https://codecov.io/gh/smoke-trees/nodejs-backend-template)
## Running the server
```
$ npm start
```
Note: This will run a server in the development environment.
For information on deploying an express application to production and learn best practices, take a look [here](https://expressjs.com/en/advanced/best-practice-performance.html).
## Logging
This directory has 2 files.
- `logger.js` exports a winston object which we use for logging. You should modify logger.js to customize your logging configuration.
- `morgan.js` exports a pre-configured morgan object to write logs using a stream to winston. It is used to intercept http requests and log the request and response details.
For more details visit the official page for [morgan](https://www.npmjs.com/package/morgan).
## Routes
Directory for defining routes. I don't think this needs more explanation.
## Additional Information
- On Linux, UNIX and Mac, running the following command adds ./node_modules/.bin to the path.
```bash
source ./activate
```
This makes it easier to run locally installed command packages.
This won't be required in many IDEs like Webstorm, but we thought it's a good idea to include it anyway.
- [standard.js](https://npmjs.com/package/standard) has been added as the default linting and styling tool
Use :
```bash
npm run lint
```
Formats the entire project, and logs out anything it couldn't fix.
- [mocha](https://npmjs.com/package/mocha) is used for testing and [chai](https://npmjs.com/package/chai) is used for assertion.
[chai-http](https://npmjs.com/package/chai) is used to test http endpoints.
Use:
```bash
npm test
```
- [nyc](https://npmjs.com/package/nyc) is used as the default coverage tool.
Use:
```bash
npm run coverage
```
* The master branch ships code for a **http** server. Checkout the **https** branch for the https server.
Replace the self-signed certificates in the certs with your own SSL certificates.
## Dependencies
| Dependency | Usage |
| ---------------------------------------------------- | ------------------------------------------------------------------ |
| [body-parser](https://npm.com/package/body-parser) | POST body parsing middleware. Adds body object to incoming request |
| [compression](https://npmjs.com/package/compression) | Response compression middleware |
| [express](https://npmjs.com/package/express) | Express REST API framework |
| [cors](https://npm.com/package/cors) | CORS middleware to set CORS policy |
| [morgan](https://npmjs.com/package/morgan) | HTTP request logger |
| [winston](https://npmjs.com/package/winston) | General purpose logger for the application |
| [nyc](https://npmjs.com/package/nyc) | Code Coverage tool |
| [standard](https://npmjs.com/package/standard) | Linting and styling tool. |
| [chai](https://npmjs.com/package/chai) | Assertion Library |
| [chai-http](https://npmjs.com/package/chai-http) | Middleware for chai to test http endpoints |