Merge pull request #84 from vndevteam/develop

feat: merge develop into main

Author: lamngockhuong

.env.docker

@@ -1,6 +1,7 @@
 NODE_ENV=development
 MODULES_SET=monolith
 APP_NAME="NestJS API"
+APP_URL=http://localhost:3000
 APP_PORT=3000
 APP_DEBUG=false
 API_PREFIX=api

.env.example

@@ -1,13 +1,31 @@
-NODE_ENV=development # local, development, staging, production, test
-MODULES_SET=monolith # monolith, api
+##== 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=console # support: console, google_logging, aws_cloudwatch
 
+# 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
 DATABASE_TYPE=postgres
 DATABASE_HOST=localhost
 DATABASE_PORT=5432

README.md

@@ -19,6 +19,8 @@
 
 NestJS boilerplate for a typical project
 
+Demo: <https://nestjs-boilerplate-n27l.onrender.com>
+
 ## Getting started
 
 ```bash
@@ -56,19 +58,19 @@ $ pnpm run start:prod
 
 ## Feature
 
-- [ ] Database. Support [TypeORM](https://www.npmjs.com/package/typeorm)
+- [x] Database. Support [TypeORM](https://www.npmjs.com/package/typeorm)
 - [ ] Seeding.
-- [ ] Config Service ([@nestjs/config](https://www.npmjs.com/package/@nestjs/config)).
+- [x] Config Service ([@nestjs/config](https://www.npmjs.com/package/@nestjs/config)).
 - [ ] Mailing ([nodemailer](https://www.npmjs.com/package/nodemailer)).
 - [ ] Sign in and sign up via email.
 - [ ] Social sign in (Apple, Facebook, Google, Twitter).
 - [ ] Admin and User roles.
-- [ ] Internationalization/Translations (I18N) ([nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n)).
+- [x] Internationalization/Translations (I18N) ([nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n)).
 - [ ] File uploads. Support local and Amazon S3 drivers.
-- [ ] Swagger.
+- [x] Swagger.
 - [ ] E2E and units tests.
-- [ ] Docker.
-- [ ] CI (Github Actions).
+- [x] Docker.
+- [x] CI (Github Actions).
 
 ## Support
 

docs/.vuepress/config.mjs

@@ -1,6 +1,6 @@
 import { viteBundler } from '@vuepress/bundler-vite';
-import { defaultTheme } from '@vuepress/theme-default';
 import { searchPlugin } from '@vuepress/plugin-search';
+import { defaultTheme } from '@vuepress/theme-default';
 import { defineUserConfig } from 'vuepress';
 import { en as enThemeConfig } from './config/theme/en.config.mjs';
 import { vi as viThemeConfig } from './config/theme/vi.config.mjs';

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

@@ -8,10 +8,18 @@ const en = {
   ],
   sidebarDepth: 1,
   sidebar: [
+    {
+      text: 'Architecture',
+      link: '/architecture.md',
+    },
     {
       text: 'Database',
       link: '/database.md',
     },
+    {
+      text: 'Security',
+      link: '/security.md',
+    },
     {
       text: 'Convention',
       children: [

docs/architecture.md

@@ -1,2 +1,264 @@
 # Architecture
 
+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)
+
+## `.github/workflows`
+
+Here you can create and store yml files for each github action.
+
+### `check-semantic-prs.yml`
+
+Github action to check if the PR title is following the semantic commit message.
+
+### `ci.yml`
+
+Github action to run the test and build the project.
+
+### `deploy-docs.yml`
+
+Github action to deploy the documentation to the `gh-pages` branch.
+
+## `.husky`
+
+Husky is a tool to prevent bad git commit, git push, and more. See [the husky doc](https://typicode.github.io/husky/) for more.
+
+## `docs`
+
+Folder where we keep all our documentation files.
+
+### `.vuepress`
+
+Folder where we keep all our vuepress configuration files. See [the vuepress doc](https://vuepress.vuejs.org/) for more.
+
+## `src`
+
+Where we keep all our source files.
+
+### `api`
+
+### `background`
+
+### `common`
+
+Where we keep common typescript files, e.g. DTOs, interfaces, types.
+
+#### `dto`
+
+Where we keep all our DTOs.
+
+#### `interfaces`
+
+Where we keep all typescript [interfaces](https://www.typescriptlang.org/docs/handbook/interfaces.html).
+
+#### `types`
+
+Where we keep all typescript [types](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html).
+
+### `config`
+
+Where we keep application configuration files.
+
+### `constants`
+
+Where we keep all our constants.
+
+### `database`
+
+Folder to store files which are connected only to database.
+
+#### `config` (for database)
+
+Folder to store database configuration files.
+
+#### `decorators` (for database)
+
+Folder to store database decorators.
+
+#### `entities`
+
+Folder to store application common entities
+
+#### `migrations`
+
+Folder to store application migrations which will be generated by typeorm.
+
+#### `seeds`
+
+Folder to store application seeds, it adds necessary data for the development.
+
+#### `data-source.ts`
+
+File to store the data source configuration for migrations.
+
+### `decorators`
+
+This folder contains all global [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html).
+
+### `exceptions`
+
+This folder contains all global exception classes.
+
+### `filters`
+
+In this folder you can find app level [filters](https://docs.nestjs.com/exception-filters).
+
+### `generated`
+
+Typescript files generated by the code generator. E.g. i18n.generated.ts file generated by [the nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n) package.
+
+### `guards`
+
+You can store all guards here.
+
+### `i18n`
+
+Internalization JSON files are storied here.
+
+### `interceptors`
+
+Where we are keep [interceptors](https://docs.nestjs.com/interceptors).
+
+### `libs`
+
+Where we keep all common modules. See [NestJS modules documentation](https://docs.nestjs.com/modules) for more.
+
+### `shared`
+
+Shared module with global singleton services.
+
+### `utils`
+
+Where we keep all our utility functions.
+
+### `app.module.ts`
+
+The root application module.
+
+### `main.ts`
+
+## `test`
+
+Folder where we keep all our e2e test files.
+
+## `.env`
+
+Environment variables which will load before app start and will be stored in `process.env`, (*) is a env name (local, development, test, staging, production)
+
+## `.gitignore`
+
+Here you can store the files and folders that you want to ignore in the git repository.
+
+## `.prettierrc`
+
+Prettier configuration file, see [the prettier doc](https://prettier.io/) for more.
+
+## `commitlint.config.mjs`
+
+Commitlint configuration file, see [the commitlint doc](https://commitlint.js.org/) for more.
+
+## `docker-compose.yml`
+
+Docker compose configuration file, see [the docker docs](https://docs.docker.com/compose/compose-file/) for more.
+
+## `Dockerfile`
+
+The basic Dockerfile configuration to build the app, see [the docker docs](https://docs.docker.com/engine/reference/builder/) for more.
+
+## `eslint.config.mjs`
+
+Eslint configuration file, see [the eslint doc](https://eslint.org/) & [typescript-eslint](https://typescript-eslint.io/) for more.
+
+## `jest.config.json`
+
+Jest configuration file, see [the jest doc](https://jestjs.io/) for more.
+
+## `lint-staged.config.mjs`
+
+The configuration of the lint-staged, see [the lint-staged doc](https://github.com/lint-staged/lint-staged) for more.
+
+## `nest-cli.json`
+
+Nestjs cli configuration file, see [the nestjs doc](https://docs.nestjs.com/) for more.
+
+## `package.json`
+
+Here you can store the configuration of the project.
+
+## `pnpm-lock.yaml`
+
+pnpm lock file generated by pnpm.
+
+## `README.md`
+
+Here you can store the description of the project.
+
+## `renovate.json`
+
+Renovate configuration file, see [the renovate doc](https://docs.renovatebot.com/) for more.
+
+## `setup-jest.mjs`
+
+Setup file for jest.
+
+## `tsconfig.build.json`
+
+Here you can store the typescript configuration of the project for the build.
+
+## `tsconfig.json`
+
+Here you can store the typescript configuration of the project.