PSheon / ack-nestjs-boilerplate-mongoose

NestJs Boilerplate. Authentication (OAuth2, API Key), Mongoose, MongoDB , Configuration, Multi Languages (i18n), etc. Advance Example πŸ₯Ά. NestJs v8.x πŸ₯³, Typescript πŸš€. Production Ready πŸ”₯

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License

NestJs NodeJs Typescript MongoDB JWT Jest Yarn Docker

ACK NestJs Boilerplate Mongoose πŸ”₯ πŸš€

Best uses for Restful API, Microservice, or SaaS Project

ack-nestjs-boilerplate-mongoose is a NestJs Boilerplate with Mongoose and MongoDB as Database.

Made with following

You can Request Feature or Report Bug with following this link

Important

If you change env value of APP_MODE to secure that will trigger more Middleware and Guard.

  1. TimestampMiddleware, tolerant 5 minutes of request.
  2. UserAgentMiddleware, whitelist of user agent.
  3. ApiKeyGuard, check api key based on database.
  4. CorsMiddleware, check cors

You can see our e2e testing file or read the documentation on section environment.

Build with

Describes which version of the main packages and main tools.

Name Version
NestJs v8.x
NodeJs v17.x
Typescript v4.x
Mongoose v6.x
MongoDB v5.x
Yarn v1.x
NPM v8.x
Docker v20.x
Docker Compose v2.x

Objective

ack-nestjs-boilerplate-mongoose have some objective.

  • Simple, scalable and secure
  • Avoid spaghetti code
  • Component based
  • Reusable component
  • Easy to maintenance
  • Support for all microservice patterns

Features

  • NestJs v8.x πŸ₯³
  • Production Ready πŸ”₯
  • Typescript πŸš€
  • Authentication and Authorization (OAuth2, API Key, Basic Auth) πŸ’ͺ
  • Mongodb integrate by using Mongoose Package πŸŽ‰
  • Database Migration
  • Integrate with AWS
  • Server Side Pagination
  • Url Versioning
  • Request Validation Pipe
  • Custom error status code 🀫
  • Logger and Debugger πŸ“
  • Centralize Configuration πŸ€–
  • Centralize Exception Filter
  • Multi-language (i18n)
  • Dynamic Setting from Database πŸ—Ώ
  • Maintenance Mode on / off
  • Advance Example πŸ₯Ά
  • 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

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. 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.

Todo

Next development

  • Docker Compose File Mongodb Replication Set
  • Swagger

Documentation

Let's go into deep ! πŸš€

Endpoints

Import endpoints.json into postman or see our e2e testing

Microservice

Nestjs microservice or Kafka integration will put in separate repo ack-microservice-nestjs-boilerplate-mongoose.

License

Distributed under MIT licensed.

Contributors

Thanks goes to these wonderful people

Tiaamoo
Tiaamoo

Contact

Andre Christi kan

Github LinkedIn Instagram

About

NestJs Boilerplate. Authentication (OAuth2, API Key), Mongoose, MongoDB , Configuration, Multi Languages (i18n), etc. Advance Example πŸ₯Ά. NestJs v8.x πŸ₯³, Typescript πŸš€. Production Ready πŸ”₯

License:MIT License


Languages

Language:TypeScript 99.8%Language:Shell 0.2%