feat: merge pull request #143 from vndevteam/develop

feat: merge develop into main

Author: lamngockhuong

README.md

@@ -59,12 +59,13 @@ $ pnpm start:prod
 ## Features
 
 - [x] Database. Support [TypeORM](https://www.npmjs.com/package/typeorm)
-- [ ] Seeding.
+- [x] Seeding.
 - [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.
+- [x] Pagination: Offset and Cursor (Clone from [typeorm-cursor-pagination](https://github.com/benjamin658/typeorm-cursor-pagination) and add more features).
 - [x] Internationalization/Translations (I18N) ([nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n)).
 - [ ] File uploads. Support local and Amazon S3 drivers.
 - [x] Swagger.

docs/.vuepress/config.mjs

@@ -8,7 +8,7 @@ import { vi as viThemeConfig } from './config/theme/vi.config.mjs';
 export default defineUserConfig({
   lang: 'en-US',
   title: 'NestJS boilerplate',
-  description: 'NestJS boilerplate',
+  description: 'NestJS boilerplate with best practices',
   base: '/nestjs-boilerplate/',
   bundler: viteBundler(),
   markdown: {
@@ -19,11 +19,11 @@ export default defineUserConfig({
   locales: {
     '/': {
       lang: 'en-US',
-      title: 'NestJS boilerplate',
+      title: 'NestJS boilerplate 🎉',
     },
     '/vi/': {
       lang: 'vi-VN',
-      title: 'NestJS boilerplate',
+      title: 'NestJS boilerplate 🎉',
     },
   },
   theme: defaultTheme({

docs/README.md

@@ -26,4 +26,18 @@ This is a boilerplate for NestJS projects. It is a starting point for building a
 
 ## References
 
-// TODO: Add references
+- [TypeScript](https://www.typescriptlang.org/)
+- [NestJS](https://docs.nestjs.com/)
+- [TypeORM](https://typeorm.io/)
+- [TypeORM Extension](https://typeorm-extension.tada5hi.net/)
+- [Jest](https://jestjs.io/)
+- [PNPM](https://pnpm.io/)
+- [ESLint](https://eslint.org/)
+- [TypeScript ESLint](https://typescript-eslint.io/)
+- [Prettier](https://prettier.io/)
+- [Husky](https://typicode.github.io/husky/)
+- [Lint Staged](https://github.com/lint-staged/lint-staged)
+- [Commitlint](https://commitlint.js.org/)
+- [Conventional Commits](https://www.conventionalcommits.org/)
+- [Commitizen](https://commitizen-tools.github.io/commitizen/)
+- [Renovate](https://docs.renovatebot.com/)

docs/database.md

@@ -2,6 +2,8 @@
 
 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.
 
+For seeding data, we use [typeorm-extension](https://github.com/tada5hi/typeorm-extension) package.
+
 ---
 
 [[toc]]
@@ -57,3 +59,82 @@ pnpm migration:up
 ```bash
 pnpm migration:down
 ```
+
+## Seeding (TypeORM)
+
+### Creating seed file
+
+1. Create seed file with `pnpm seed:create` command:
+
+    ```bash
+    pnpm seed:create src/database/seeds/post-seeder
+    ```
+
+2. Go to `src/database/seeds/xxxtimestampxxx-post-seeder.ts` and write your seed data:
+
+    ```typescript
+    // /src/database/seeds/xxxtimestampxxx-post-seeder.ts
+    import { PostEntity } from '@/api/post/entities/post.entity';
+    import { DataSource } from 'typeorm';
+    import { Seeder, SeederFactoryManager } from 'typeorm-extension';
+
+    export class PostSeederxxxtimestampxxx implements Seeder {
+      track = false;
+
+      public async run(
+        dataSource: DataSource,
+        factoryManager: SeederFactoryManager,
+      ): Promise<any> {
+        // Creating post by using repository
+        const repository = dataSource.getRepository(PostEntity);
+        await repository.insert(
+          new PostEntity({
+            title: 'Post 1',
+            content: 'Content 1',
+          }),
+        );
+
+        // Creating post by using factory
+        const postFactory = factoryManager.get(PostEntity);
+        await postFactory.saveMany(5);
+      }
+    }
+    ```
+
+    In `run` method extend your logic, you can use repository or factory to create data.
+
+3. Apply this seed to database via `pnpm seed:run`.
+
+### Running seed
+
+```bash
+pnpm seed:run
+```
+
+### Factory and Faker
+
+To create entities with random data, create a factory for each desired entity. The definition of a factory is **optional**. If you don't define a factory, the seeder will use the repository to create entities.
+
+The factory callback provides an instance of the [faker](https://fakerjs.dev/guide/) library as function argument, to populate the entity with random data.
+
+1. Create factory file at `src/database/factories/post.factory.ts`:
+
+    ```typescript
+    import { PostEntity } from '@/api/post/entities/post.entity';
+    import { setSeederFactory } from 'typeorm-extension';
+
+    export default setSeederFactory(PostEntity, (fake) => {
+      const post = new PostEntity();
+      post.title = fake.lorem.sentence();
+      post.content = fake.lorem.paragraph();
+
+      return post;
+    });
+    ```
+
+2. Use factory in `src/database/seeds/xxxtimestampxxx-post-seeder.ts`
+3. Run seed:
+
+    ```bash
+    pnpm seed:run
+    ```

package.json

@@ -24,6 +24,10 @@
     "migration:show": "pnpm typeorm migration:show",
     "migration:create": "typeorm migration:create",
     "migration:generate": "pnpm typeorm migration:generate --pretty",
+    "db:create": "env-cmd ts-node ./node_modules/typeorm-extension/bin/cli.cjs db:create",
+    "db:drop": "env-cmd ts-node ./node_modules/typeorm-extension/bin/cli.cjs db:drop",
+    "seed:run": "env-cmd ts-node ./node_modules/typeorm-extension/bin/cli.cjs seed:run",
+    "seed:create": "env-cmd ts-node ./node_modules/typeorm-extension/bin/cli.cjs seed:create",
     "prepare": "husky",
     "docs:dev": "vuepress dev docs",
     "docs:build": "vuepress build docs"
@@ -52,38 +56,39 @@
     "nodemailer": "6.9.14",
     "pg": "8.12.0",
     "pino-http": "10.2.0",
-    "pino-pretty": "11.2.1",
+    "pino-pretty": "11.2.2",
     "reflect-metadata": "0.2.2",
     "rxjs": "7.8.1",
     "typeorm": "0.3.20",
+    "typeorm-extension": "3.6.0",
     "uuid": "10.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "19.3.0",
     "@commitlint/config-conventional": "19.2.2",
-    "@eslint/js": "9.7.0",
+    "@eslint/js": "9.8.0",
     "@nestjs/cli": "10.4.2",
-    "@nestjs/schematics": "10.1.2",
+    "@nestjs/schematics": "10.1.3",
     "@nestjs/testing": "10.3.10",
     "@swc/cli": "0.4.0",
-    "@swc/core": "1.7.0",
+    "@swc/core": "1.7.3",
     "@types/compression": "1.7.5",
     "@types/eslint__js": "8.42.3",
     "@types/express": "4.17.21",
     "@types/jest": "29.5.12",
     "@types/ms": "0.7.34",
-    "@types/node": "20.14.11",
+    "@types/node": "20.14.13",
     "@types/nodemailer": "6.4.15",
     "@types/supertest": "6.0.2",
     "@types/uuid": "10.0.0",
     "@vuepress/bundler-vite": "2.0.0-rc.14",
-    "@vuepress/plugin-search": "2.0.0-rc.39",
-    "@vuepress/theme-default": "2.0.0-rc.39",
+    "@vuepress/plugin-search": "2.0.0-rc.40",
+    "@vuepress/theme-default": "2.0.0-rc.40",
     "env-cmd": "10.1.0",
-    "eslint": "9.7.0",
+    "eslint": "9.8.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.2.1",
-    "husky": "9.1.1",
+    "husky": "9.1.4",
     "jest": "29.7.0",
     "lint-staged": "15.2.7",
     "prettier": "3.3.3",
@@ -95,9 +100,9 @@
     "ts-node": "10.9.2",
     "tsconfig-paths": "4.2.0",
     "tslib": "2.6.3",
-    "typescript": "5.5.3",
-    "typescript-eslint": "7.16.1",
-    "vue": "3.4.33",
+    "typescript": "5.5.4",
+    "typescript-eslint": "7.18.0",
+    "vue": "3.4.34",
     "vuepress": "2.0.0-rc.14"
   }
 }