Http NestJs v9.x Boilerplate.

You can Request Feature or Report Bug with following this link

• Important
• Next Todo
• Build With
• Objective
• Features
• Prerequisites
• Getting Started
  • Clone Repo
  • Install Dependencies
  • Create environment
  • Database Migration
  • Test
  • Run Project
  • Run Project with Docker
• API Reference
• Environment
• Api Key Encryption
• Adjust Mongoose Setting
• License
• Contact

If you change env value of APP_ENV to production that will trigger

1. CorsMiddleware will implement src/configs/middleware.config.ts, else default is *.
2. Documentation will disable

Next development

• Implement Repository Design Pattern / Data Access Object Design Pattern
• Swagger for API Documentation
• Support Serverless
• Mongo Repository soft delete
• Make it simple
• Encrypt jwt payload
• Optimize Unit Testing
• Optimize Swagger (Ongoing)
• Add Relational Database Repository, ex: mysql, postgres (Ongoing)
• Update Documentation, include an diagram for easier comprehension
• Export to excel and Import from excel add options to background process
• OAuth2 Client Credentials
• AuthApi Controller
• Maybe will adopt CQRS

Describes which version .

• Easy to maintenance
• NestJs Habit
• Component based folder structure
• Repository Design Pattern or Data Access Layer Design Pattern
• Support Microservice Architecture, Clean Architecture, and/or Hexagonal Architecture
• Follow The Twelve-Factor App
• Adopt SOLID and KISS principle

• NestJs v9.x 🥳
• Typescript 🚀
• Production ready 🔥
• Support serverless
• Swagger included
• Authentication and authorization (JWT, API Key) 💪
• Role management system
• Storage integration with AwsS3
• Upload file single and multipart to AwsS3
• Support multi-language i18n 🗣
• Request validation with class-validation
• Serialization with class-transformer
• Url Versioning
• Server Side Pagination, there have 3 of types
• Import and export data with excel by using decorator

• MongoDB integrate by using mongoose 🎉
• PostgreSQL integrate by using typeorm 🎊 (Ongoing)
• Multi Database
• Database Transaction
• Database Soft Delete
• Database Migration

• Logger Morgan and Debugger Winston 📝

• Apply helmet, cors, and rate-limit
• Timeout awareness and can override ⌛️
• User agent awareness, and can whitelist user agent

• Support environment file
• Centralize configuration 🤖
• Centralize response
• Centralize exception filter
• Setting from database 🗿
• Maintenance mode on / off from database 🐤

• Support Docker Installation
• Support CI/CD with Github Action or Jenkins
• Husky GitHook For Check Source Code, and Run Test Before Commit 🐶
• Linter with EsLint for Typescript

We assume that everyone who comes here is programmer with intermediate knowledge and we also need to understand more before we begin in order to reduce the knowledge gap.

1. Understand NestJs Fundamental, Main Framework. NodeJs Framework with support fully TypeScript.
2. UnderstandTypescript Fundamental, Programming Language. It will help us to write and read the code.
3. Understand ExpressJs Fundamental, NodeJs Base Framework. It will help us in understanding how the NestJs Framework works.
4. Understand what NoSql is and how it works as a database, especially MongoDB.
5. Understand Repository Design Pattern or Data Access Object Design Pattern. It will help us to read the source code
6. Understand The SOLID Principle and KISS Principle for better write the code.
7. Optional. Understand Microservice Architecture Clean Architecture, and/or Hexagonal Architecture.
8. Optional. Understand The Twelve Factor Apps
9. Optional. Understand Docker that can help you to run the project

Before we start, we need to install some packages and tools. Recommend version is LTS Version for every tool and package.

Make sure check that tools has been installed successfully.

1. NodeJs
2. MongoDB as Replication
3. Yarn
4. Git
5. Docker
6. Docker-Compose
7. Serverless

Clone ack-nestjs-boilerplate with git.

git clone https://github.com/andrechristikan/ack-nestjs-boilerplate.git

This project need some dependencies. Let's go install it.

yarn install

Make your own environment with copy from .env.example and edit some value.

cp .env.example .env

Jump to details

If you want to to implement transaction, you must to install Mongodb Replication Set.

Database migration ack-nestjs-boilerplate used NestJs-Command

For migrate

yarn migrate

For rollback

yarn rollback

ack-nestjs-boilerplate provide 3 automation testing unit testing, integration testing, and e2e testing.

yarn test

For specific test use this

• Unit testing

  yarn test:unit

• Integration testing

  yarn test:integration

• E2E testing

  yarn test:e2e

If mongodb version < 5, Read this section for adjust mongoose setting.

Finally, Cheers 🍻🍻 !!! we passed all steps.

Now we can run ack-nestjs-boilerplate and use all of features.

yarn start:dev

docker-compose up -d

We have already provided the API reference. To visit, click here.

Detail information about the environment

ApiKeyHashed using sha256 encryption, and then encryption for dataObject is AES256. Please keep the secret keep private.

To do the encryption

1. Concat the key and secret.

   const apiKeyString = `${key}:${secret}`;

2. Encryption apiKeyString with sha256

   const apiKeyHashed = this.helperHashService.sha256(`${key}:${secret}`);
   // e11a023bc0ccf713cb50de9baa5140e59d3d4c52ec8952d9ca60326e040eda54

3. Then put the apiKeyHashed into dataObject

   const timestamp = this.helperDateService.timestamp(); 
   const data: IAuthApiRequestHashedData = {
       key: "qwertyuiop12345zxcvbnmkjh",
       timestamp,
       hash: apiKeyHashed,
   }

4. Encryption the dataObject with AES 256

   These data encryptionKey, and passphrase can be find in database.

   const passphrase = 'cuwakimacojulawu'; // <--- IV for encrypt AES 256
   const encryptionKey = 'opbUwdiS1FBsrDUoPgZdx';
   const apiKeyEncryption = await authApiService.encryptApiKey(
       data,
       encryptionKey,
       passphrase
   );

5. Last, combine the key and apiKeyEncryption

   const xApiKey = `${key}:${apiEncryption}`;

6. Send into request. Put the xApiKey in request headers

   {
       "headers": {
           "x-api-key": "${xApiKey}",
   
           ...
           ...
           ...
       }
   }

Just is case, if your mongodb version is < 5

Go to file src/common/database/services/database.options.service.ts and remove comment useMongoClient then set value to true.

const mongooseOptions: MongooseModuleOptions = {
    uri,
    useNewUrlParser: true,
    useUnifiedTopology: true,
    serverSelectionTimeoutMS: 5000,
    useMongoClient: true
};

Distributed under MIT licensed.

Andre Christi kan