Merge pull request #244 from andrechristikan/development

Development

Author: andrechristikan

.github/workflows/stale.yml

@@ -11,7 +11,7 @@ jobs:
       pull-requests: write
 
     steps:
-      - uses: actions/stale@v5
+      - uses: actions/stale@v6
         with:
           days-before-issue-stale: 7
           days-before-issue-close: 7

README.md

@@ -15,10 +15,33 @@
 
 # ACK NestJs Boilerplate Mongoose  🔥 🚀
 
-ack-nestjs-mongoose-kafka is Hybrid NestJs Application. [NestJs Http][ref-nestjs] and [NestJs Microservice](ref-nestjsmicroservice).
+ack-nestjs-mongoose-kafka is Hybrid NestJs Application. [NestJs Http][ref-nestjs] and [NestJs Microservice][ref-nestjsmicroservice].
 
 *You can [Request Feature][ack-issues] or [Report Bug][ack-issues] with following this link*
 
+## Table of contents
+
+* [Important](#important)
+* [Next Todo](#next-todo)
+* [Build With](#build-with)
+* [Objective](#objective)
+* [Features](#features)
+* [Prerequisites](#prerequisites)
+* [Getting Started](#getting-started)
+    * [Clone Repo](#clone-repo)
+    * [Install Dependencies](#install-dependencies)
+    * [Create environment](#create-environment)
+    * [Database Migration](#database-migration)
+    * [Test](#test)
+    * [Run Project](#run-project)
+    * [Run Project with Docker](#run-project-with-docker)
+* [API Reference](#api-reference)
+* [Environment](#environment)
+* [Api Key Encryption](#api-key-encryption)
+* [Adjust Mongoose Setting](#adjust-mongoose-setting)
+* [License](#license)
+* [Contact](#contact)
+
 ## Important
 
 > ack-nestjs-mongoose-kafka still on trial and error phase and the test will base on real projects or cases. So there will be (always) have new update and new features.
@@ -32,20 +55,20 @@ If you change env value of `APP_ENV` to `production` that will trigger
 
 Next development
 
-- [x] Implement Repository Design Pattern / Data Access Object Design Pattern
-- [x] Swagger for API Documentation
-- [x] Support Serverless
-- [x] Mongo Repository soft delete
-- [x] Make it simple
-- [ ] Optimize Swagger
-- [ ] Add Relational Database Repository, ex: mysql, postgres
-- [ ] Update Documentation, include an diagram for easier comprehension
-- [ ] Export to excel and Import from excel add options to background process
-- [ ] AuthApi Controller
-- [ ] OAuth2 Client Credentials
-- [ ] Kafka Module Security
-- [ ] Optimize Kafka Module
-- [ ] Maybe will adopt [CQRS](https://docs.nestjs.com/recipes/cqrs)
+* [x] Implement Repository Design Pattern / Data Access Object Design Pattern
+* [x] Swagger for API Documentation
+* [x] Support Serverless
+* [x] Mongo Repository soft delete
+* [x] Make it simple
+* [ ] Optimize Swagger
+* [ ] Add Relational Database Repository, ex: mysql, postgres
+* [ ] Update Documentation, include an diagram for easier comprehension
+* [ ] Export to excel and Import from excel add options to background process
+* [ ] AuthApi Controller
+* [ ] OAuth2 Client Credentials
+* [ ] Kafka Module Security
+* [ ] Optimize Kafka Module
+* [ ] Maybe will adopt [CQRS][ref-nestjs-cqrs]
 
 ## Build with
 
@@ -69,110 +92,110 @@ Describes which version .
 
 ## Objective
 
-- 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
+* 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
 
 ## Features
 
-- NestJs v9.x 🥳
-- Typescript 🚀
-- Production ready 🔥
-- Support serverless
-- Swagger included
-- Authentication and authorization (`JWT`, `API Key`) 💪
-- Role management system
-- MongoDB integrate by using `mongoose` 🎉
-- Support MongoDB Transaction
-- Support MongoDB Soft Delete
-- Database Migration with `NestJs-Command`
-- 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`
+* NestJs v9.x 🥳
+* Typescript 🚀
+* Production ready 🔥
+* Support serverless
+* Swagger included
+* Authentication and authorization (`JWT`, `API Key`) 💪
+* Role management system
+* MongoDB integrate by using `mongoose` 🎉
+* Support MongoDB Transaction
+* Support MongoDB Soft Delete
+* Database Migration with `NestJs-Command`
+* 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`
 
 ### Logger and Debugger
 
-- Logger `Morgan` and Debugger `Winston` 📝
+* Logger `Morgan` and Debugger `Winston` 📝
 
 ### Security
 
-- Apply `helmet`, `cors`, and `rate-limit`
-- Timeout awareness and can override ⌛️
-- User agent awareness, and can whitelist user agent
+* Apply `helmet`, `cors`, and `rate-limit`
+* Timeout awareness and can override ⌛️
+* User agent awareness, and can whitelist user agent
 
 ### Setting
 
-- Support environment file
-- Centralize configuration 🤖
-- Centralize response
-- Centralize exception filter
-- Setting from database 🗿
-- Maintenance mode on / off from database 🐤
+* Support environment file
+* Centralize configuration 🤖
+* Centralize response
+* Centralize exception filter
+* Setting from database 🗿
+* Maintenance mode on / off from database 🐤
 
 ### Others
 
-- 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
+* 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](http://nestjs.com), Main Framework. NodeJs Framework with support fully TypeScript.
-2. Understand[Typescript Fundamental](ref-typescript), Programming Language. It will help us to write and read the code.
-3. Understand [ExpressJs Fundamental](ref-nodejs), 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.](ref-mongodb)
+1. Understand [NestJs Fundamental][ref-nestjs], Main Framework. NodeJs Framework with support fully TypeScript.
+2. Understand[Typescript Fundamental][ref-typescript], Programming Language. It will help us to write and read the code.
+3. Understand [ExpressJs Fundamental][ref-nodejs], 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.][ref-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. Understand Apache Kafka. It will help us to build the application.
 8. Optional. Understand Microservice Architecture Clean Architecture, and/or Hexagonal Architecture.
-9. Optional. Understand [The Twelve Factor Apps](ref-12factor)
-10. Optional. Understand [Docker](ref-docker) that can help you to run the project
+9. Optional. Understand [The Twelve Factor Apps][ref-12factor]
+10. Optional. Understand [Docker][ref-docker] that can help you to run the project
 
-### Getting Started
+## Getting Started
 
 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](ref-nodejs)
-2. [MongoDB as Replication](ref-mongodb)
-3. [Yarn](ref-yarn)
-4. [Git](ref-git)
-5. [Docker](ref-docker)
-6. [Docker-Compose](ref-dockercompose)
-7. [Serverless](ref-serverless)
-8. [Kafka](ref-kafka)
+1. [NodeJs][ref-nodejs]
+2. [MongoDB as Replication][ref-mongodb]
+3. [Yarn][ref-yarn]
+4. [Git][ref-git]
+5. [Docker][ref-docker]
+6. [Docker-Compose][ref-dockercompose]
+7. [Serverless][ref-serverless]
+8. [Kafka][ref-kafka]
 
-#### Clone Repo
+### Clone Repo
 
 Clone ack-nestjs-mongoose with git.
 
 ```bash
 git clone https://github.com/andrechristikan/ack-nestjs-mongoose.git
 ```
 
-#### Install Dependencies
+### Install Dependencies
 
 This project need some dependencies. Let's go install it.
 
 ```bash
 yarn install
 ```
 
-#### Create environment
+### Create environment
 
 Make your own environment with copy from `.env.example` and edit some value.
 
@@ -182,11 +205,11 @@ cp .env.example .env
 
 [Jump to details](#environment)
 
-#### Database Migration
+### Database Migration
 
 > If you want to to implement `transaction`, you must to install `Mongodb Replication Set`.
 
-Database migration ack-nestjs-mongoose used [NestJs-Command](ref-nestjscommand)
+Database migration ack-nestjs-mongoose used [NestJs-Command][ref-nestjscommand]
 
 For migrate
 
@@ -200,7 +223,7 @@ For rollback
 yarn rollback
 ```
 
-#### Kafka topics
+### Kafka topics
 
 Create kafka topics
 
@@ -224,27 +247,27 @@ ack-nestjs-mongoose provide 3 automation testing `unit testing`, `integration te
 yarn test
 ```
 
-#### Specific test
+For specific test use this
 
-For unit testing
+* Unit testing
 
-```bash
-yarn test:unit
-```
+    ```bash
+    yarn test:unit
+    ```
 
-For integration testing
+* Integration testing
 
-```bash
-yarn test:integration
-```
+    ```bash
+    yarn test:integration
+    ```
 
-For E2E testing
+* E2E testing
 
-```bash
-yarn test:e2e
-```
+    ```bash
+    yarn test:e2e
+    ```
 
-#### Run Project
+### Run Project
 
 > If mongodb version < 5, [Read this section for adjust mongoose setting.](#adjust-mongoose-setting)
 
@@ -256,12 +279,16 @@ Now we can run ack-nestjs-mongoose and use all of features.
 yarn start:dev
 ```
 
-#### Run Project with Docker
+### Run Project with Docker
 
 ```bash
 docker-compose up -d
 ```
 
+## API Reference
+
+We have already provided the API reference. To visit, [click here][api-reference-docs].
+
 ## Environment
 
 Detail information about the environment
@@ -482,21 +509,18 @@ Distributed under [MIT licensed][license].
 [author-github]: https://github.com/andrechristikan
 
 <!-- Repo LINKS -->
-[ack-repo]: https://github.com/andrechristikan/ack-nestjs-mongoose-kafka
-[ack-e2e]: /test/e2e/
 [ack-issues]: https://github.com/andrechristikan/ack-nestjs-mongoose-kafka/issues
 [ack-stars]: https://github.com/andrechristikan/ack-nestjs-mongoose-kafka/stargazers
 [ack-forks]: https://github.com/andrechristikan/ack-nestjs-mongoose-kafka/network/members
 [ack-contributors]: https://github.com/andrechristikan/ack-nestjs-mongoose-kafka/graphs/contributors
-[ack-history]: https://github.com/andrechristikan/ack-nestjs-mongoose-kafka/commits/main
 
 <!-- license -->
 [license]: LICENSE.md
 
 <!-- Reference -->
 [ref-nestjs]: http://nestjs.com
 [ref-nestjsmicroservice]: https://docs.nestjs.com/microservices/basics
-[ref-mongoose]: https://mongoosejs.com/
+[ref-nestjs-cqrs]: https://docs.nestjs.com/recipes/cqrs
 [ref-mongodb]: https://docs.mongodb.com/
 [ref-nodejs]: https://nodejs.org/
 [ref-typescript]: https://www.typescriptlang.org/
@@ -509,3 +533,7 @@ Distributed under [MIT licensed][license].
 [ref-kafka]: https://kafka.apache.org/documentation
 [ref-jwt]: https://jwt.io
 [ref-jest]: https://jestjs.io/docs/getting-started
+[ref-git]: https://git-scm.com
+
+<!-- API Reference -->
+[api-reference-docs]: https://lgtw8uvhvd.execute-api.ap-southeast-3.amazonaws.com/development/docs