Merge pull request #297 from RUKAYAT-CODER/feat-env-validation

Env Validation,Database Migration, Databae performance Indexes and Soft Delete

Author: mftee

backend/.github/workflows/deploy.yml

@@ -0,0 +1,62 @@
+name: Deploy
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+          POSTGRES_USER: ${{ secrets.DATABASE_USER }}
+          POSTGRES_DB: ${{ secrets.DATABASE_NAME }}
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '18'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Build application
+      run: npm run build
+    
+    - name: Run database migrations
+      run: npm run migrate
+      env:
+        DATABASE_HOST: localhost
+        DATABASE_PORT: 5432
+        DATABASE_USER: ${{ secrets.DATABASE_USER }}
+        DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+        DATABASE_NAME: ${{ secrets.DATABASE_NAME }}
+        NODE_ENV: production
+    
+    - name: Start application
+      run: npm run start:prod
+      env:
+        DATABASE_HOST: localhost
+        DATABASE_PORT: 5432
+        DATABASE_USER: ${{ secrets.DATABASE_USER }}
+        DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+        DATABASE_NAME: ${{ secrets.DATABASE_NAME }}
+        NODE_ENV: production
+        # Add other required environment variables as secrets

backend/README.md

@@ -24,7 +24,42 @@
 
 ## Description
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+[SMALDA](https://github.com/RUKAYAT-CODER/SMALDA) - Secure Document Management and Ledger Anchoring system built with NestJS.
+
+## Database Migrations
+
+This project uses TypeORM migrations for database schema management.
+
+### Migration Commands
+
+```bash
+# Generate a new migration
+npm run migration:generate -- -n MigrationName
+
+# Run all pending migrations
+npm run migration:run
+
+# Revert the last migration
+npm run migration:revert
+
+# Show migration status
+npm run migration:show
+
+# Run migrations with CI/CD script
+npm run migrate
+```
+
+### Migration Files
+
+Migration files are located in `src/migrations/` and are automatically compiled to `dist/migrations/`.
+
+### CI/CD Integration
+
+The deployment pipeline automatically runs migrations before starting the application:
+
+1. Database connection check
+2. Run pending migrations
+3. Start the application
 
 ## Project setup
 

backend/ormconfig.js

@@ -0,0 +1,18 @@
+require('dotenv').config();
+
+module.exports = {
+  type: 'postgres',
+  host: process.env.DATABASE_HOST,
+  port: parseInt(process.env.DATABASE_PORT || '5432'),
+  username: process.env.DATABASE_USER,
+  password: process.env.DATABASE_PASSWORD,
+  database: process.env.DATABASE_NAME,
+  entities: ['dist/**/*.entity.js'],
+  migrations: ['dist/migrations/*.js'],
+  cli: {
+    entitiesDir: 'dist',
+    migrationsDir: 'dist/migrations',
+  },
+  synchronize: false,
+  logging: false,
+};

backend/ormconfig.json

@@ -0,0 +1,14 @@
+{
+  "type": "postgres",
+  "host": "localhost",
+  "port": 5432,
+  "username": "postgres",
+  "password": "adetomi.54",
+  "database": "smalda",
+  "entities": ["src/**/*.entity.ts"],
+  "migrations": ["src/migrations/*.ts"],
+  "cli": {
+    "entitiesDir": "src",
+    "migrationsDir": "src/migrations"
+  }
+}