https://github.com/bertoni/node-api-skeleton

https://github.com/bertoni/node-api-skeleton

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/bertoni/node-api-skeleton
• Owner: bertoni
• Created: 2020-03-30T23:42:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T17:59:58.000Z (almost 2 years ago)
• Last Synced: 2023-05-04T21:15:06.026Z (over 1 year ago)
• Language: JavaScript
• Size: 1.73 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node API Skeleton

This project was thought to create the ground to build REST APIs with Node.js.

To this, was used the Express framework, Winston to logger, Jest to tests and other tools.

### Features

Already was wrote some features:

- Segregation structure folders to give more independence to your modules.

- Load routes dynamically only adding the route file in your folder.

- Logger structure to use in whole project.

- Dynamic Dependency Injection (DI) for Models, Repositories and Controllers with [awilix](https://github.com/jeffijoe/awilix)

- Implemented CorrelationID inside logger to allow track back the request inside modules.

- Implementing test structure to facilitate other modules that you will build

- Using `link-module-alias` to easily call other modules without need know all structure and lose control of paths

- Hot reload to development faster

- Documenting API with swagger using @notation

### How Use

Start application

````

npm run dev

````

Run tests

````

npm run test

````

Run tests with coverage

````

npm run coverage

````