migration setup

Author: daniwebdev

.eslintrc.js

@@ -5,6 +5,7 @@ module.exports = {
     tsconfigRootDir: __dirname,
     sourceType: 'module',
   },
+  exports: ["migrations/**/*"],
   plugins: ['@typescript-eslint/eslint-plugin'],
   extends: [
     'plugin:@typescript-eslint/recommended',
@@ -15,7 +16,8 @@ module.exports = {
     node: true,
     jest: true,
   },
-  ignorePatterns: ['.eslintrc.js'],
+
+  ignorePatterns: ['.eslintrc.js', 'typings', "migrations/**/*"],
   rules: {
     '@typescript-eslint/interface-name-prefix': 'off',
     '@typescript-eslint/explicit-function-return-type': 'off',

Dockerfile

@@ -28,10 +28,10 @@ RUN --mount=type=bind,source=package.json,target=package.json \
 USER node
 
 # Copy the rest of the source files into the image.
-COPY . .
+# COPY . .
 
 # Expose the port that the application listens on.
 EXPOSE 8100
 
 # Run the application.
-CMD yarn run start:dev
+# CMD yarn run start:dev

compose.yaml

@@ -7,10 +7,11 @@
 # You can add other services your application may depend on here, such as a
 # database or a cache. For examples, see the Awesome Compose repository:
 # https://github.com/docker/awesome-compose
-name: ${PROJECT_NAME}
+name: starter-kit
 services:
   app:
     container_name: "starter-kit-app"
+    image: starter-kit/backend:latest
     build:
       context: .
     environment:
@@ -31,7 +32,6 @@ services:
       - -c
       - |
         yarn install
-        yarn run build
         yarn run start:dev
 
   pgsql:
@@ -45,6 +45,17 @@ services:
       - ${DB_EXPOSED_PORT:-8611}:5432
     networks:
       - network
+    healthcheck:
+        test:
+            - CMD
+            - pg_isready
+            - '-q'
+            - '-d'
+            - 'db-starter-kit'
+            - '-U'
+            - '${DB_USER}'
+        retries: 3
+        timeout: 5s
 
   redis:
     container_name: "starter-kit-redis"

migrations/1696849524727-createUsersTable.ts

@@ -44,22 +44,22 @@ export class CreateUsersTable1696849524727 implements MigrationInterface {
                 },
                 {
                     name: "email_verified_at",
-                    type: "datetime",
+                    type: "timestamp",
                     isNullable: true,
                 },
                 {
                     name: "phone_verified_at",
-                    type: "datetime",
+                    type: "timestamp",
                     isNullable: true,
                 },
                 {
                     name: "created_at",
-                    type: "datetime",
+                    type: "timestamp",
                     default: "now()",
                 },
                 {
                     name: "updated_at",
-                    type: "datetime",
+                    type: "timestamp",
                     default: "now()",
                 }
             ],

migrations/datasource.ts

@@ -0,0 +1,22 @@
+import { DataSource, DataSourceOptions } from "typeorm"
+import { config as dotenvConfig } from 'dotenv';
+
+dotenvConfig({ path: '.env' });
+
+const typeOrmDataSource = new DataSource({
+    name: 'default',
+    type: "postgres",
+    database: process.env.DB_NAME,
+    username: process.env.DB_USER,
+    password: process.env.DB_PASS,
+    host: process.env.DB_HOST,
+    port: parseInt(process.env.DB_PORT ?? "5432"),
+    migrations: [
+        "migrations/*-*.{ts,js}"
+    ],
+    synchronize: false,
+    migrationsTableName: "migrations",
+})
+
+
+export default typeOrmDataSource;

nest-cli.json

@@ -13,7 +13,7 @@
       {
         "include": "i18n/**/*",
         "watchAssets": true,
-        "outDir": "dist/src"
+        "outDir": "dist"
       }
     ]
   }

package.json

@@ -19,7 +19,10 @@
     "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",
     "nest": "nest",
-    "typeorm": "typeorm"
+    "typeorm": "ts-node ./node_modules/typeorm/cli",
+    "migration:run": "npm run typeorm migration:run -- -d ./migrations/datasource.ts",
+    "migration:create": "npm run typeorm -- migration:create ./src/migrations/$npm_config_name",
+    "migration:revert": "npm run typeorm -- -d ./migrations/datasource.ts migration:revert"
   },
   "dependencies": {
     "@google-cloud/storage": "^6.12.0",

src/config/typeorm.config.ts

@@ -1,5 +1,7 @@
 import { TypeOrmModuleAsyncOptions, TypeOrmModuleOptions } from "@nestjs/typeorm";
 import { join } from "path";
+import { DataSource, DataSourceOptions } from "typeorm";
+
 export const defaultTypeOrmConfig: TypeOrmModuleAsyncOptions = {
     useFactory: () => {
         return {
@@ -14,10 +16,11 @@ export const defaultTypeOrmConfig: TypeOrmModuleAsyncOptions = {
                 join(__dirname, '..', '**', '*.entity{.ts,.js}')
             ],
             synchronize: false,
+            migrationsTableName: "migrations",
             poolSize: 10,
             poolErrorHandler: (err) => {
                 console.log('db pooling error:', err)
             }
-        }
+        };
     }
-}
+}

src/main.ts

@@ -30,7 +30,7 @@ async function bootstrap() {
     .addTag('Auth', "All about authentication")
     .build();
   const document = SwaggerModule.createDocument(app, config);
-  SwaggerModule.setup('api', app, document);
+  SwaggerModule.setup('docs', app, document);
 
   await app.listen(APP_PORT);
 
@@ -42,6 +42,7 @@ async function bootstrap() {
 
   if(process.env.APP_EXPOSED_PORT != undefined) {
     console.log(`App Exposed on http://0.0.0.0:${process.env.APP_EXPOSED_PORT}`);
+    console.log(`Swagger Exposed on http://0.0.0.0:${process.env.APP_EXPOSED_PORT}/docs`);
   }
 
   console.log("--------------------------------------------------------");

tsconfig.json

@@ -17,5 +17,6 @@
     "strictBindCallApply": false,
     "forceConsistentCasingInFileNames": false,
     "noFallthroughCasesInSwitch": false
-  }
+  },
+  "include": ["src/**/*", "typings/*"]
 }