TEMPLATE-NESTJS

Description

This template could be considered like my ultimate template for Nest.js. A lot of thoughts has been put into it for having a structure flexible, a quality of code easy to review and an application easy to scale.

Features

• Docker-compose environments: Using the command of the package.json, two environments for docker-compose has been created. There are located in the env folder at the root of the project.
• Reverse proxy: With the jwilder, a simple configuration of the url has been implemented and can be found in the env files under the VIRTUAL_HOST and VIRTUAL_PORT configuration.
• Refresh token: A refresh token has been implemented to give the frontend ability to refresh the access token
• healthcheck: The healthcheck has been implement on every container
• Quality of code: For checking the quality of the code, Sonar has been configured and linked to the test and coverage
• Initialization of mongodb: A script has been implemented for initializing mongodb upon creation with some data such the admin user.
• In memory database: For improving the speed of the test's execution, the database has been connected to mongodb-memory-server
• Absolute Path: Relative path at more than one level has been removed using module-alias for writting only absolute path
• Javascript Typing: The entire code has been typed using typescript
• Javascript Typing Coverage: The coverage of the typing of the element is checked using typescript-coverage-report
• Load testing: The code can be tested against concurrency using Artillery
• Smoke testing: Using Artillery, the main functionnalities of the code can be tested rapidly
• CRUD abstract class: An abstract class for creating a rapid crud has been created. Every service can got the functionnalities by extending the class.
• Shared and custom exceptions: A set of custom exceptions has been created for easily add new one based on the Nest.js one.
• Centralization of constants: All the constants of the app has been centralized in one place
• Centralization of process environment variable: All the variable for the configModule has been centralized in one place
• Documentation: The documentation for the whole project is managed with compodoc
• Linter: Eslint has been added to the project with also prettier for adding some rules of style

Docker-compose

$ docker-compose down
$ docker-compose up -d --build

The command has been added in the package.json, so it can also be start and stop with :

$ npm run start
$ npm run stop

Nginx

Description

Using jwilder/nginx-proxy for creating proxy on server by reading the services in dockercompose.

You can connect to the different server using those url:

• server1: api.server1.net

Adding new proxy

For adding a new proxy, be sure to do those two step:

1. Give the two environment variables VIRTUAL_HOST and VIRTUAL_PORT in the docker-compose to the services you want to proxy.
2. Create a line in the host file with the following command:

$ sudo nano /etc/host

Then add the following line:

127.0.0.1 api.server1.net api.server2.net api.server3.net

Mongodb

The init file in the mongodb/init folder with be use for initializing the admin authentication in the server3. In case, it does not work, look in lazydocker.

If you dont find the reason, delete the container with the volume and delete the folder mongodb/data using sudo rm -rf command.

Checking

A good way to test if service are up is by using the ping command. By example, you could check if the server2 is up with this command :

$ ping api.server2.net

mongo "mongodb://admin:test@localhost:28017/test?authSource=admin"

Links

• https://www.compose.com/articles/why-and-how-to-redis-with-your-mongodb/