chore: merge pull request #115 from vndevteam/develop

chore: merge develop into main

Author: lamngockhuong

.env.example

@@ -1,28 +1,16 @@
 ##== Environment
-# NODE_ENV values: local, development, staging, production, test
 NODE_ENV=development
-
-# MODULES_SET values: monolith, api
 MODULES_SET=monolith
 
 ##== Application
 APP_NAME="NestJS API"
 APP_URL=http://localhost:3000
 APP_PORT=3000
-
-# APP_DEBUG values: true, false
 APP_DEBUG=false
-
 API_PREFIX=api
 APP_FALLBACK_LANGUAGE=en
-
-# APP_LOG_LEVEL values: fatal, error, warn, info, debug, trace, silent
 APP_LOG_LEVEL=debug
-
-# APP_LOG_SERVICE values: console, google_logging, aws_cloudwatch
 APP_LOG_SERVICE=console
-
-# APP_CORS_ORIGIN values: * | true | false | domain1,domain2,domain3 (comma-separated)
 APP_CORS_ORIGIN=http://localhost:3000,http://example.com
 
 ##== Database
@@ -45,7 +33,7 @@ DATABASE_CERT=
 AUTH_JWT_SECRET=secret
 AUTH_JWT_TOKEN_EXPIRES_IN=15m
 AUTH_REFRESH_SECRET=secret_for_refresh
-AUTH_REFRESH_TOKEN_EXPIRES_IN=3650d
+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

README.md

@@ -47,16 +47,16 @@ When you use this template, try follow the checklist to update your info properl
 
 ```bash
 # development
-$ pnpm run start
+$ pnpm start
 
 # watch mode
-$ pnpm run start:dev
+$ pnpm start:dev
 
 # production mode
-$ pnpm run start:prod
+$ pnpm start:prod
 ```
 
-## Feature
+## Features
 
 - [x] Database. Support [TypeORM](https://www.npmjs.com/package/typeorm)
 - [ ] Seeding.
@@ -72,6 +72,10 @@ $ pnpm run start:prod
 - [x] Docker.
 - [x] CI (Github Actions).
 
+## More documentations
+
+Please read the [docs](docs/README.md). It contains the details about the project structure, conventions, and more.
+
 ## References
 
 - [Awesome Nest Boilerplate](https://github.com/NarHakobyan/awesome-nest-boilerplate)

docs/.vuepress/config.mjs

@@ -11,6 +11,11 @@ export default defineUserConfig({
   description: 'NestJS boilerplate',
   base: '/nestjs-boilerplate/',
   bundler: viteBundler(),
+  markdown: {
+    toc: {
+      level: [2, 3, 4, 5],
+    },
+  },
   locales: {
     '/': {
       lang: 'en-US',

docs/README.md

@@ -1,5 +1,7 @@
 # NestJS Boilerplate Documentation
 
+This is a boilerplate for NestJS projects. It is a starting point for building a RESTful API with NestJS.
+
 - [Setup & Development](development.md)
 - [Architecture](architecture.md)
 - [Database](database.md)

docs/architecture.md

@@ -2,60 +2,9 @@
 
 This document describes the architecture of the project.
 
-- [Architecture](#architecture)
-  - [`.github/workflows`](#githubworkflows)
-    - [`check-semantic-prs.yml`](#check-semantic-prsyml)
-    - [`ci.yml`](#ciyml)
-    - [`deploy-docs.yml`](#deploy-docsyml)
-  - [`.husky`](#husky)
-  - [`docs`](#docs)
-    - [`.vuepress`](#vuepress)
-  - [`src`](#src)
-    - [`api`](#api)
-    - [`background`](#background)
-    - [`common`](#common)
-      - [`dto`](#dto)
-      - [`interfaces`](#interfaces)
-      - [`types`](#types)
-    - [`config`](#config)
-    - [`constants`](#constants)
-    - [`database`](#database)
-      - [`config` (for database)](#config-for-database)
-      - [`decorators` (for database)](#decorators-for-database)
-      - [`entities`](#entities)
-      - [`migrations`](#migrations)
-      - [`seeds`](#seeds)
-      - [`data-source.ts`](#data-sourcets)
-    - [`decorators`](#decorators)
-    - [`exceptions`](#exceptions)
-    - [`filters`](#filters)
-    - [`generated`](#generated)
-    - [`guards`](#guards)
-    - [`i18n`](#i18n)
-    - [`interceptors`](#interceptors)
-    - [`libs`](#libs)
-    - [`shared`](#shared)
-    - [`utils`](#utils)
-    - [`app.module.ts`](#appmodulets)
-    - [`main.ts`](#maints)
-  - [`test`](#test)
-  - [`.env`](#env)
-  - [`.gitignore`](#gitignore)
-  - [`.prettierrc`](#prettierrc)
-  - [`commitlint.config.mjs`](#commitlintconfigmjs)
-  - [`docker-compose.yml`](#docker-composeyml)
-  - [`Dockerfile`](#dockerfile)
-  - [`eslint.config.mjs`](#eslintconfigmjs)
-  - [`jest.config.json`](#jestconfigjson)
-  - [`lint-staged.config.mjs`](#lint-stagedconfigmjs)
-  - [`nest-cli.json`](#nest-clijson)
-  - [`package.json`](#packagejson)
-  - [`pnpm-lock.yaml`](#pnpm-lockyaml)
-  - [`README.md`](#readmemd)
-  - [`renovate.json`](#renovatejson)
-  - [`setup-jest.mjs`](#setup-jestmjs)
-  - [`tsconfig.build.json`](#tsconfigbuildjson)
-  - [`tsconfig.json`](#tsconfigjson)
+---
+
+[[toc]]
 
 ## `.github/workflows`
 

docs/conventions/branch-conventions.md

@@ -1,5 +1,7 @@
 # Branch conventions
 
+[[toc]]
+
 ## Code Flow Branches
 
 These branches which we expect to be permanently available on the repository follow the flow of code changes starting from development until the production.

docs/conventions/commit-conventions.md

@@ -2,6 +2,10 @@
 
 We use convention at [here](https://www.conventionalcommits.org/en/v1.0.0/)
 
+---
+
+[[toc]]
+
 ## Commit messages must be matched by the following regex
 
 ```js

docs/conventions/linting.md

@@ -2,6 +2,10 @@
 
 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.
 
+---
+
+[[toc]]
+
 ## Languages
 
 - **Typescript** is linted by Typescript Eslint and formatted by Prettier

docs/conventions/naming-cheatsheet.md

@@ -2,31 +2,7 @@
 
 > Source: <https://github.com/kettanaito/naming-cheatsheet/blob/main/README.md>
 
-- [Naming cheatsheet](#naming-cheatsheet)
-  - [English language](#english-language)
-  - [Naming convention](#naming-convention)
-  - [S-I-D](#s-i-d)
-  - [Avoid contractions](#avoid-contractions)
-  - [Avoid context duplication](#avoid-context-duplication)
-  - [Reflect the expected result](#reflect-the-expected-result)
-- [Naming functions](#naming-functions)
-  - [A/HC/LC Pattern](#ahclc-pattern)
-  - [Actions](#actions)
-    - [`get`](#get)
-    - [`set`](#set)
-    - [`reset`](#reset)
-    - [`remove`](#remove)
-    - [`delete`](#delete)
-    - [`compose`](#compose)
-    - [`handle`](#handle)
-  - [Context](#context)
-  - [Prefixes](#prefixes)
-    - [`is`](#is)
-    - [`has`](#has)
-    - [`should`](#should)
-    - [`min`/`max`](#minmax)
-    - [`prev`/`next`](#prevnext)
-  - [Singular and Plurals](#singular-and-plurals)
+[[toc]]
 
 ---
 

docs/database.md

@@ -1,10 +1,10 @@
 # Work with database
 
-- [Working with database entity (TypeORM)](#working-with-database-entity-typeorm)
-  - [Generate migration](#generate-migration)
-  - [Show migration](#show-migration)
-  - [Run migration](#run-migration)
-  - [Revert migration](#revert-migration)
+We use [TypeORM](https://typeorm.io/) as an ORM for working with databases. It supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, WebSQL databases.
+
+---
+
+[[toc]]
 
 ## Working with database entity (TypeORM)
 
@@ -35,7 +35,7 @@
 1. Next, generate migration file:
 
     ```bash
-    pnpm run migration:generate src/database/migrations/create-post-table
+    pnpm migration:generate src/database/migrations/create-post-table
     ```
 
 1. Apply this migration to database via [pnpm migration:up](#run-migration).

docs/deployment.md

@@ -1 +1,53 @@
 # Deployment
+
+This document outlines the steps required to deploy the application to a production environment.
+
+---
+
+[[toc]]
+
+## Prerequisites
+
+- Access to the production server
+- Necessary credentials for database and other services
+- The latest version of the application code
+
+## Steps
+
+1. **Prepare the Environment**:
+   - Ensure the production server is running and accessible.
+   - Verify that all required software is installed on the server.
+
+2. **Upload the Application**:
+   - Use SCP or FTP to transfer the application files to the server.
+   - Place the files in the appropriate directory.
+
+3. **Configure the Application**:
+   - Copy the `.env.production` file to the server, if applicable.
+   - Update any environment-specific configuration settings.
+
+4. **Set Up the Database**:
+   - Create the production database, if not already set up.
+   - Run migrations and seed the database with any necessary data.
+
+5. **Start the Application**:
+   - Depending on the application, this might involve starting a web server, a background job processor, etc.
+   - Ensure that all services are running as expected.
+
+6. **Verify the Deployment**:
+   - Access the application through its public URL to ensure it's running correctly.
+   - Check application logs for any errors or warnings.
+
+7. **Monitor the Application**:
+   - Set up monitoring and alerting tools to keep track of the application's health and performance.
+
+## Rollback Plan
+
+In case of any issues, have a rollback plan ready:
+
+- Keep the previous version of the application ready for deployment.
+- Ensure database backups are taken before the deployment, to restore if necessary.
+
+## Conclusion
+
+Following these steps will help ensure a smooth deployment process. Always test thoroughly in a staging environment before deploying to production.