Merge remote-tracking branch 'origin/main' into 5-post-api

Author: MCSwainConnor

.env

@@ -0,0 +1 @@
+DATABASE_URL="postgresql://postgres:postgres@localhost:5432/app_db"

.github/workflows/ci-cd.yml

@@ -0,0 +1,35 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['main']
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Repository checkout
+        uses: actions/checkout@v4
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22.21.0'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate Prisma
+        run: npm run prisma generate
+
+      - name: Build
+        run: npm run build
+
+      - name: Run Tests
+        run: npm run test
+
+      - name: Run Lint
+        run: npm run lint

.gitignore

@@ -1,4 +1,5 @@
 node_modules
-.env
+.env*
+!.env
 dist
 src/generated

README.md

@@ -4,12 +4,14 @@
 
 ```sh
 npm install
+docker compose up -d  # start postgres
 npm run prisma generate
-docker compose up  # start postgres
+
 ```
 
 ## Starting the API
 
 ```sh
+npm run prisma:reset    # reset and reseed the db for dev before starting the dev server
 npm run start:dev
 ```

eslint.config.mjs

@@ -27,6 +27,7 @@ export default tseslint.config(
       '@typescript-eslint/no-explicit-any': 'error',
       '@typescript-eslint/no-floating-promises': 'error',
       '@typescript-eslint/no-unsafe-argument': 'warn',
+      '@typescript-eslint/explicit-function-return-type': 'error',
     },
   },
 );

nest-cli.json

@@ -3,6 +3,15 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
-    "deleteOutDir": true
+    "deleteOutDir": true,
+    "plugins": [
+      {
+        "name": "@nestjs/swagger",
+        "options": {
+          "classValidatorShim": true,
+          "introspectComments": true
+        }
+      }
+    ]
   }
 }