ACK NestJs Boilerplate 🔥 🚀

This repo will representative of authentication service and authorization service

[ACK NestJs][ack] is a Http NestJs v10.x boilerplate. Best uses for backend service.

You can request feature or report bug with following this link

Table of contents

• ACK NestJs Boilerplate 🔥 🚀
  • Table of contents
  • Important
  • TODO
  • Prerequisites
  • Build with
  • Objective
  • Features
    • Main Features
  • Installation
    • Clone Repo
    • Install Dependencies
    • Create environment
    • Database Migration and Seed
    • Email Migration
    • Run Project
  • Installation with Docker
  • Test
  • Swagger
    • API Key
    • User
  • BullMQ Board
    • User
  • Redis Client Web Base
  • MongoDB Client Web Base
    • User
  • License
  • Contribute
  • Contact

Important

Very limited documentation

• There have been some breaking changes between v5 and v6.
• The features will be relate with AWS / Amazon web service
• Stateless Authorization
• Must run MongoDB as a replication set for database transactions.
• If you want to implement Google SSO. You must have google cloud console account, then create your own Credential to get the clientId and clientSecret.
• If you want to implement Apple SSO. You must have clientId and signInClientId.
• If you change the environment value of APP_ENV to production, that will trigger.
  1. CorsMiddleware will implement config from src/configs/middleware.config.ts.
  2. Documentation will disable.
  3. Global prefix will remove. Before is /api.
• For monitoring, this project will use sentry.io, and only send 500 or internal server error.

TODO

• Export Module
• Move to Stateful Authorization 1. Session Module 2. Device Module 3. Password Period Module 5. Reset Password Module 6. Verification Module

Prerequisites

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. Understand Typescript 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 and how database works, especially NoSql and MongoDB.
5. Understand Repository Design Pattern or Data Access Object Design Pattern. It will help to read, and write 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. It can help you to understand more deep about this project.
8. Optional. Understanding The Twelve Factor Apps. It can help to serve the project.
9. Optional. Understanding Docker.

Build with

Describes which version.

Name	Version
NestJs	v10.x
NestJs Swagger	v7.x
NodeJs	v20.x
Typescript	v5.x
Mongoose	v10.x
MongoDB	v7.x
Yarn	v1.x
NPM	v10.x
Docker	v24.x
Docker Compose	v2.x

Objective

• Easy to maintenance
• NestJs Habit
• Component based / modular folder structure
• Stateless authentication and authorization
• Repository Design Pattern or Data Access Layer Design Pattern
• Follow Community Guide Line
• Follow The Twelve-Factor App
• Adopt SOLID and KISS principle
• Support for Microservice Architecture, Serverless Architecture, Clean Architecture, and/or Hexagonal Architecture

Features

Main Features

• NestJs 10.x 🥳
• Typescript 🚀
• Production ready 🔥
• MongoDB integrate by using mongoose 🎉
• Cached response with redis
• Queue bullmq with redis
• Authorization, Role Management.
• Repository Design Pattern (Multi Repository, can mix with other orm)
• Authentication (Access Token, Refresh Token, API Key, Google SSO, Apple SSO)
• Import and export data with CSV or Excel by using decorator
• Support multi-language i18n 🗣, can controllable with request header x-custom-lang
• Request validation for all request params, query, dan body with class-validation
• Swagger / OpenAPI 3 included
• Url Versioning, default version is 1
• Server Side Pagination
• Sentry.io for Monitoring Tools
• Support Docker installation
• Support CI/CD (Eg: Github Action)
• Husky GitHook for run linter before commit 🐶
• Linter with EsLint for Typescript

Installation

Before start, we need to install some packages and tools. The recommended version is the LTS version for every tool and package.

Make sure to check that the tools have been installed successfully.

1. NodeJs
2. MongoDB
3. Redis
4. Yarn
5. Git

Clone Repo

Clone the project with git.

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

Install Dependencies

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

yarn install

Create environment

Make your own environment file with a copy of env.example and adjust values to suit your own environment.

cp .env.example .env

Database Migration and Seed

By default the options of AutoCreate and AutoIndex will be false. Thats means the schema in MongoDb will not change with the latest. So to update the schema we need to run

yarn migrate

After migrate the schema, also we need to run data seed

yarn seed

Email Migration

Optional

The email will automatically create email template through AWS SES if we set the value at .env file

For migrate

yarn migrate:email

Run Project

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

Now you can run the project.

yarn start:dev

Installation with Docker

For docker installation, we need more tools to be installed.

1. Docker
2. Docker-Compose

Make your own environment file with a copy of env.example and adjust values to suit your own environment.

cp .env.example .env

then run

docker-compose up -d

Test

The project only provide unit testing.

yarn test

Swagger

You can check The Swagger after running this project. Url localhost:3000/docs and don't for get to put x-api-key on header.

API Key

api key: v8VB0yY887lMpTA2VJMV api key secret: zeZbtGTugBTn3Qd5UXtSZBwt7gn3bg

User

1. Super Admin
   • email: superadmin@mail.com
   • password: aaAA@123
2. Admin
   • email: admin@mail.com
   • password: aaAA@123
3. Member
   • email: member@mail.com
   • password: aaAA@123
4. User
   • email: user@mail.com
   • password: aaAA@123

BullMQ Board

This available with docker installation

You can check and monitor your queue. Url localhost:3010

User

• email: admin
• password: admin123

Redis Client Web Base

This available with docker installation

You can check redis data using redis-commander. Url localhost:3011

MongoDB Client Web Base

This available with docker installation

You can check mongodb data using mongo-express. Url localhost:3012

User

• email: admin
• password: admin123

License

Distributed under MIT licensed.

Contribute

How to contribute in this repo

1. Fork the repository
2. Create your branch git checkout -b my-branch
3. Commit any changes to your branch
4. Push your changes to your remote branch
5. Open a pull request

If your code behind commit with the original/main branch, please update your code and resolve the conflict.

Contact

Andre Christi kan