AndresSepar/node-ts-boilerplate

A Nodejs RestAPI boilerplate using: Typescript, MongoDB, Redis, SocketIO

Node API boilerplate

1. Ecosystem

• MongoDb as database: using Mongoose as ODM

• Socketio with multi nodes support: using the redis socketio adapter

• TravisCI for CI/CD

2. Quick start

2.1. Project structure

• Separate Express 'app' and 'server': allowing a flexible testing environement of the API using Chai HTTP
• Solution structured by self-contained components (features): each feature (For example auth or rooms) contains it's own logic:
  - Routes
  - Controllers
  - Services
  - Validations
  - Models
  - Unit tests

2.1. Error Handling

• Errors handled centrally, not within a middlewares: see src/middlewares/error.ts.
• Operational and programmer errors are seperated: we use a custom error class for this to extend the built in Error class (see src/utils/ApiError.ts)
• Error logging using Winston: see src/utils/logger.ts

2.2. Code Style Practices

• Eslint + Prettier + VsCode configuration to enforce code styles on file save
• Husky + lint-staged to enforce code styles before commits

2.3. Testing

• Unit testing of services using Mocha, Chai, and Chai-spies
• e2e testing using Chai-http

2.4. Socket

• Multinode support using redis socketio adapter
• Socket handlers separated per topic
• Socket authentification middleware

2.5. Docker

• We use multistage builds

2.6. TravisCI

Really simple CI/CD pipeline that gets triggered on every commit.

3. Prospects

• Integrate test coverage into the CI/CD pipeline