feat: Setup Database Connect & swagger

.env.example

@@ -0,0 +1,12 @@
+NODE_ENV=production
+
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USERNAME=cophr
+DB_PASSWORD=secret
+DB_DATABASE=cophr
+DB_TIMEZONE="+08:00"
+
+APP_SWAGGER_Title="NestJS-Board API"
+APP_SWAGGER_Description="This is NestJS-Board API documentation."
+APP_SWAGGER_Version="0.0.1"

.gitignore

@@ -13,6 +13,7 @@ lerna-debug.log*
 
 # OS
 .DS_Store
+.env
 
 # Tests
 /coverage

README.md

@@ -58,6 +58,25 @@ $ npm run test:e2e
 $ npm run test:cov
 ```
 
+## Migration
+
+```bash
+# build and according to dist/**/*.entity.js difference between previous and now to generate sql queries
+$ yarn migration:generate src/database/migrations/{THIS_migration_DO}
+
+# build and create new empty migration which custom sql queries
+$ yarn migration:create src/database/migrations/{THIS_migration_DO}
+
+# build and run with sql queries to update a database
+$ yarn migration:run
+
+# build and view current status which database migration version
+$ yarn migration:show
+
+# build and revert database to previous version
+$ yarn migration:revert
+```
+
 ## Support
 
 Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).

package.json

@@ -19,6 +19,12 @@
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
+    "typeorm": "npm run build && npx typeorm -d ./dist/config/data-source.js",
+    "migration:generate": "npm run typeorm -- migration:generate",
+    "migration:create": "npm run typeorm -- migration:create",
+    "migration:run": "npm run typeorm -- migration:run",
+    "migration:show": "npm run typeorm -- migration:show",
+    "migration:revert": "npm run typeorm -- migration:revert",
     "prepare": "husky install"
   },
   "lint-staged": {
@@ -27,11 +33,21 @@
   },
   "dependencies": {
     "@nestjs/common": "^9.0.0",
+    "@nestjs/config": "^2.2.0",
     "@nestjs/core": "^9.0.0",
+    "@nestjs/mapped-types": "*",
     "@nestjs/platform-express": "^9.0.0",
+    "@nestjs/swagger": "^6.1.4",
+    "@nestjs/typeorm": "^9.0.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "dotenv": "^16.0.3",
+    "mysql2": "^2.3.3",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
-    "rxjs": "^7.2.0"
+    "rxjs": "^7.2.0",
+    "swagger-ui-express": "^4.6.0",
+    "typeorm": "^0.3.11"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.3.0",

src/app.module.ts

@@ -1,10 +1,19 @@
 import { Module } from "@nestjs/common";
+import { ConfigModule } from "@nestjs/config";
+import { TypeOrmModule } from "@nestjs/typeorm";
 
 import { AppController } from "./app.controller";
 import { AppService } from "./app.service";
+import { dataSourceOptions } from "./config/data-source";
+import { validate } from "./config/env.validation";
 
 @Module({
-  imports: [],
+  imports: [
+    ConfigModule.forRoot({
+      validate,
+    }),
+    TypeOrmModule.forRoot(dataSourceOptions),
+  ],
   controllers: [AppController],
   providers: [AppService],
 })

src/config/data-source.ts

@@ -0,0 +1,23 @@
+import * as dotenv from "dotenv";
+import { DataSource, DataSourceOptions } from "typeorm";
+
+dotenv.config();
+export const dataSourceOptions: DataSourceOptions = {
+  type: "mysql",
+  host: process.env.DB_HOST,
+  port: parseInt(process.env.DB_PORT, 10),
+  username: process.env.DB_USERNAME,
+  password: process.env.DB_PASSWORD,
+  database: process.env.DB_DATABASE,
+  timezone: process.env.DB_TIMEZONE,
+  entities: [__dirname + "/../**/*.entity.js"],
+  migrations: [__dirname + "/../database/migrations/*.js"],
+  extra: {
+    charset: "utf8mb4_unicode_ci",
+  },
+  synchronize: false,
+  logging: false,
+};
+
+const dataSource = new DataSource(dataSourceOptions);
+export default dataSource;

src/config/env.validation.ts

@@ -0,0 +1,58 @@
+import { plainToInstance } from "class-transformer";
+import {
+  IsEnum,
+  IsNotEmpty,
+  IsNumber,
+  IsString,
+  validateSync,
+} from "class-validator";
+
+export enum Environment {
+  Development = "development",
+  Production = "production",
+  Test = "test",
+  Provision = "provision",
+}
+
+class EnvironmentVariables {
+  @IsEnum(Environment)
+  NODE_ENV: Environment = Environment.Production;
+
+  @IsString()
+  @IsNotEmpty()
+  DB_HOST: string;
+
+  @IsNumber()
+  @IsNotEmpty()
+  DB_PORT: number;
+
+  @IsString()
+  @IsNotEmpty()
+  DB_USERNAME: string;
+
+  @IsString()
+  @IsNotEmpty()
+  DB_PASSWORD: string;
+
+  @IsString()
+  @IsNotEmpty()
+  DB_DATABASE: string;
+
+  @IsString()
+  @IsNotEmpty()
+  DB_TIMEZONE: string;
+}
+
+export function validate(config: Record<string, unknown>) {
+  const validatedConfig = plainToInstance(EnvironmentVariables, config, {
+    enableImplicitConversion: true,
+  });
+  const errors = validateSync(validatedConfig, {
+    skipMissingProperties: false,
+  });
+
+  if (errors.length > 0) {
+    throw new Error(errors.toString());
+  }
+  return validatedConfig;
+}

src/main.ts

@@ -1,9 +1,24 @@
+import { INestApplication } from "@nestjs/common";
 import { NestFactory } from "@nestjs/core";
+import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
 
 import { AppModule } from "./app.module";
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+  setupSwagger(app);
   await app.listen(3000);
 }
+
+function setupSwagger(app: INestApplication) {
+  const builder = new DocumentBuilder();
+  const config = builder
+    .setTitle(process.env.APP_SWAGGER_Title)
+    .setDescription(process.env.APP_SWAGGER_Description)
+    .setVersion(process.env.APP_SWAGGER_Version)
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup("api", app, document);
+}
+
 bootstrap();