CI/CD github action workflow

Author: ernitingarg

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.eslintrc

@@ -0,0 +1,19 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended"
+    ],
+    "rules": {
+        "@typescript-eslint/interface-name-prefix": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unused-vars": "off"
+      }
+  }

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI/CD pipeline
+
+on: push
+
+jobs:
+  backend:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: test
+          POSTGRES_PASSWORD: password123
+          POSTGRES_DB: testdb
+        ports:
+          - 5432:5432
+
+    env:
+      JWT_SECRET_KEY: 5OQ1ZE9FJiP0d3PKTnOT
+      DATABASE_URL: postgresql://test:password123@localhost:5432/testdb?schema=public
+
+    steps:
+      - name: Notify Trigger
+        run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event on branch ${{ github.ref }}."
+
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+
+      - name: Cache Dependencies
+        uses: actions/cache@v2
+        id: backend-npm-cache
+        with:
+          path: "node_modules"
+          key: client-npm-${{ hashFiles('package.json') }}
+
+      - name: Install Dependencies
+        run: npm install
+        if: steps.backend-npm-cache.outputs.cache-hit != 'true'
+
+      - name: Run Linter
+        run: npm run lint
+
+      - name: Run Typecheck
+        run: npm run typecheck
+
+      - name: Execute Migrations
+        run: npx prisma migrate deploy
+
+      - name: Run Test
+        run: npm run test
+
+      - name: Display Job Status
+        run: echo "🍏 This job's status is ${{ job.status }}."

README.md

@@ -21,7 +21,7 @@ npm install @faker-js/faker tap ts-mock-imports
 
 ```
 npm install -D ts-node ts-node-dev typescript @types/node dotenv nodemon @types/bcrypt
-
+npm install -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
 npm install -D @types/tap sinon
 ```
 
@@ -63,10 +63,16 @@ To run database directly inside container, please follow below steps:
 
 - To change environment variables, please use [.env](.env.example) file
 
-- Run docker container
+- Run db docker container and app
+
+```base
+npm run start
+```
+
+- Run database docker container
 
 ```bash
-npm run start:docker
+npm run start:db
 ```
 
 - To stop docker container