chore: merge pull request #118 from vndevteam/develop

chore: merge develop into main

Author: lamngockhuong

.env.docker

@@ -1,14 +1,18 @@
+##== Environment
 NODE_ENV=development
-MODULES_SET=monolith
-APP_NAME="NestJS API"
+
+##== Application
+APP_NAME="NestJS Boilerplate API"
 APP_URL=http://localhost:3000
 APP_PORT=3000
-APP_DEBUG=false
+APP_DEBUG=true
 API_PREFIX=api
 APP_FALLBACK_LANGUAGE=en
 APP_LOG_LEVEL=debug
 APP_LOG_SERVICE=console
+APP_CORS_ORIGIN=http://localhost:3000,https://ngockhuong.com
 
+##== Database
 DATABASE_TYPE=postgres
 DATABASE_HOST=db
 DATABASE_PORT=5432
@@ -23,3 +27,22 @@ DATABASE_REJECT_UNAUTHORIZED=false
 DATABASE_CA=
 DATABASE_KEY=
 DATABASE_CERT=
+
+MAIL_HOST=maildev
+MAIL_PORT=1025
+MAIL_USER=
+MAIL_PASSWORD=
+MAIL_IGNORE_TLS=true
+MAIL_SECURE=false
+[email protected]
+MAIL_DEFAULT_NAME=Example
+
+##== Authentication
+AUTH_JWT_SECRET=secret
+AUTH_JWT_TOKEN_EXPIRES_IN=1d
+AUTH_REFRESH_SECRET=secret_for_refresh
+AUTH_REFRESH_TOKEN_EXPIRES_IN=365d
+AUTH_FORGOT_SECRET=secret_for_forgot
+AUTH_FORGOT_TOKEN_EXPIRES_IN=30m
+AUTH_CONFIRM_EMAIL_SECRET=secret_for_confirm_email
+AUTH_CONFIRM_EMAIL_TOKEN_EXPIRES_IN=1d

.gitignore

@@ -38,10 +38,15 @@ lerna-debug.log*
 
 # dotenv environment variable files
 .env
-.env.development.local
+.env.local
+.env.test
 .env.test.local
+.env.development
+.env.development.local
+.env.staging
+.env.staging.local
+.env.production
 .env.production.local
-.env.local
 
 # temp directory
 .temp

docs/.vuepress/config/theme/en.config.mjs

@@ -12,10 +12,18 @@ const en = {
       text: 'Setup & Development',
       link: '/development.md',
     },
+    {
+      text: 'Technologies',
+      link: '/technologies.md',
+    },
     {
       text: 'Architecture',
       link: '/architecture.md',
     },
+    {
+      text: 'API',
+      link: '/api.md',
+    },
     {
       text: 'Database',
       link: '/database.md',
@@ -32,14 +40,14 @@ const en = {
       text: 'Deployment',
       link: '/deployment.md',
     },
-    {
-      text: 'Techniques',
-      link: '/techniques.md',
-    },
     {
       text: 'Troubleshooting',
       link: '/troubleshooting.md',
     },
+    {
+      text: 'FAQ',
+      link: '/faq.md',
+    },
     {
       text: 'Convention',
       children: [
@@ -48,7 +56,7 @@ const en = {
         '/conventions/clean-code-typescript.md',
         '/conventions/branch-conventions.md',
         '/conventions/commit-conventions.md',
-        '/conventions/linting.md',
+        '/conventions/linting-and-formatting.md',
       ],
     },
   ],

docs/README.md

@@ -2,13 +2,15 @@
 
 This is a boilerplate for NestJS projects. It is a starting point for building a RESTful API with NestJS.
 
+## Detail Documentation
+
 - [Setup & Development](development.md)
 - [Architecture](architecture.md)
 - [Database](database.md)
 - [Security](security.md)
 - [Testing](testing.md)
 - [Deployment](deployment.md)
-- [Techniques](techniques.md)
+- [Technologies](technologies.md)
 - [Troubleshooting](troubleshooting.md)
 - Convention
   - [Naming cheatsheet](conventions/naming-cheatsheet.md)
@@ -17,3 +19,11 @@ This is a boilerplate for NestJS projects. It is a starting point for building a
   - [Branch conventions](conventions/branch-conventions.md)
   - [Commit conventions](conventions/commit-conventions.md)
   - [Linting & formatting](conventions/linting.md)
+
+## Features
+
+// TODO: Add features
+
+## References
+
+// TODO: Add references

docs/api.md

@@ -0,0 +1,17 @@
+# API Documentation
+
+This section provides an overview of the API documentation for the project.
+
+---
+
+[[toc]]
+
+## Endpoints
+
+We use swagger to document the API endpoints. You can access the API documentation by visiting the `/api-docs` route in your browser.
+
+For example, if your application is running on `http://localhost:3000`, you can access the API documentation at <http://localhost:3000/api-docs>.
+
+## Authentication
+
+## Error Handling

docs/conventions/branch-conventions.md

@@ -1,5 +1,7 @@
 # Branch conventions
 
+---
+
 [[toc]]
 
 ## Code Flow Branches

docs/conventions/linting.md docs/conventions/linting-and-formatting.md

@@ -1,4 +1,4 @@
-# Linting & formatting
+# Linting & Formatting
 
 This project uses [Typescript Eslint](https://typescript-eslint.io/), and [Prettier](https://prettier.io/) to catch errors and avoid bike-shedding by enforcing a common code style.
 

docs/deployment.md

@@ -41,6 +41,10 @@ This document outlines the steps required to deploy the application to a product
 7. **Monitor the Application**:
    - Set up monitoring and alerting tools to keep track of the application's health and performance.
 
+## CI/CD Pipeline
+
+// TODO: Add details on setting up a CI/CD pipeline for automated deployments.
+
 ## Rollback Plan
 
 In case of any issues, have a rollback plan ready:

docs/development.md

@@ -120,7 +120,7 @@ AUTH_CONFIRM_EMAIL_TOKEN_EXPIRES_IN=1d
 - `AUTH_CONFIRM_EMAIL_SECRET`: The email confirmation token secret key.
 - `AUTH_CONFIRM_EMAIL_TOKEN_EXPIRES_IN`: Email confirmation token expiration time. Should be short for security.
 
-### Dev server
+### Running the project
 
 ```bash
 # Start the development server

docs/faq.md

@@ -0,0 +1,3 @@
+# FAQ
+
+// TODO: Add FAQ

docs/techniques.md

@@ -0,0 +1,139 @@
+# Technologies
+
+List of technologies (framework, dependencies and tools) used in the project.
+
+---
+
+[[toc]]
+
+## Core Technologies
+
+We utilize the following frameworks for our backend development to create scalable and maintainable server-side applications.
+
+### Node.js
+
+A JavaScript runtime built on Chrome's V8 JavaScript engine, enabling the building of fast and scalable server-side applications.
+
+### NestJS
+
+A progressive Node.js framework for building efficient and scalable server-side applications with a modular architecture.
+
+## Frameworks and Libraries
+
+### Express
+
+A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
+
+### TypeScript
+
+A superset of JavaScript that adds static types, enhancing code reliability and maintainability.
+
+## Database
+
+### TypeORM
+
+An Object-Relational Mapping (ORM) library for TypeScript and JavaScript that simplifies database interactions and provides a powerful query builder.
+
+### PostgreSQL
+
+A powerful, open-source object-relational database system known for its reliability, robustness, and performance.
+
+## Authentication and Authorization
+
+### JWT (jsonwebtoken)
+
+A library for working with JSON Web Tokens, aiding in user authentication and authorization.
+
+## Validation and Parsing
+
+### class-validator
+
+A library for input validation and sanitization based on decorators and metadata reflection.
+
+### class-transformer
+
+A library for object transformation and serialization using decorators and reflection.
+
+## Logging and Monitoring
+
+### Pino
+
+A fast and feature-rich logging library for Node.js applications, providing high performance and low overhead.
+
+## Testing
+
+### Jest
+
+A comprehensive testing framework for JavaScript, supporting unit, integration, and end-to-end testing.
+
+### Supertest
+
+A library for testing HTTP servers, allowing you to make requests and assert responses in your tests.
+
+## Package Management
+
+### PNPM
+
+A fast, disk space-efficient package manager for JavaScript, improving the installation process and dependency management.
+
+## Linting and Formatting
+
+### ESLint
+
+A pluggable linting utility for JavaScript and TypeScript, helping to identify and fix code quality issues.
+
+### Prettier
+
+An opinionated code formatter that enforces consistent style by parsing code and reprinting it with its own rules.
+
+## Git Hooks and Commit Management
+
+### Husky
+
+A tool for managing Git hooks, allowing you to run scripts during various Git stages.
+
+### Commitlint
+
+A tool for linting commit messages, ensuring they adhere to a conventional format.
+
+### Commitizen
+
+A command-line tool for formatting commit messages according to the conventional commit standard.
+
+### Lint-staged
+
+A tool for running linters on staged files, ensuring that only clean code is committed.
+
+## DevOps and CI/CD
+
+### GitHub Actions
+
+A CI/CD service that automates workflows, allowing you to build, test, and deploy your code directly from GitHub.
+
+### Docker
+
+A platform for developing, shipping, and running applications in containers, providing an efficient and consistent environment for deployment.
+
+### Renovate
+
+A tool for automating dependency updates, keeping your project up-to-date with the latest versions.
+
+## Documentation
+
+### Markdown
+
+A lightweight markup language with plain-text formatting syntax, used for writing documentation and README files.
+
+### VuePress
+
+A static site generator that simplifies the creation of documentation sites, providing a clean and responsive design.
+
+## Miscellaneous
+
+### env-cmd
+
+A utility for executing commands using environment variables from a file, simplifying the management of environment configurations.
+
+## Conclusion
+
+These tools and frameworks are integral to our development process, ensuring that we can build high-quality, scalable, and maintainable software efficiently.