diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index b9fc7940..f88c0515 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,25 +1,116 @@
-name: CI
+name: CI/CD Pipeline
on:
push:
- branches: [ main ]
+ branches: [ main, develop ]
pull_request:
- branches: [ main ]
+ branches: [ main, develop ]
jobs:
+ lint:
+ runs-on: ubuntu-latest
+
+ 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: Run ESLint
+ run: npm run lint
+
+ test:
+ runs-on: ubuntu-latest
+
+ 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: Generate Prisma Client
+ run: npm run db:generate
+ env:
+ DATABASE_URL: postgresql://postgres:postgres@localhost:5432/test
+
+ - name: Run tests
+ run: npm test
+ env:
+ DATABASE_URL: postgresql://postgres:postgres@localhost:5432/test
+ JWT_SECRET: test-secret-key
+ JWT_REFRESH_SECRET: test-refresh-secret-key
+
build:
runs-on: ubuntu-latest
+ needs: [lint, test]
+
+ 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: Upload build artifacts
+ uses: actions/upload-artifact@v3
+ with:
+ name: dist
+ path: dist/
+
+ deploy-staging:
+ runs-on: ubuntu-latest
+ needs: [build]
+ if: github.ref == 'refs/heads/develop'
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Download build artifacts
+ uses: actions/download-artifact@v3
+ with:
+ name: dist
+
+ - name: Deploy to staging
+ run: |
+ echo "Deploying to staging environment..."
+ # Add your deployment commands here
+ # Example: scp -r dist/* user@staging-server:/path/to/app
+
+ deploy-production:
+ runs-on: ubuntu-latest
+ needs: [build]
+ if: github.ref == 'refs/heads/main'
+
steps:
- - uses: actions/checkout@v4
- - name: Use Node.js
- uses: actions/setup-node@v4
- with:
- node-version: '18'
- - name: Install dependencies
- run: npm ci
- - name: Lint
- run: npm run lint
- - name: Build
- run: npm run build
- - name: Run tests
- run: npm test --silent
+ - uses: actions/checkout@v3
+
+ - name: Download build artifacts
+ uses: actions/download-artifact@v3
+ with:
+ name: dist
+
+ - name: Deploy to production
+ run: |
+ echo "Deploying to production environment..."
+ # Add your deployment commands here
+ # Example: scp -r dist/* user@production-server:/path/to/app
diff --git a/docs/Email_Templates.md b/docs/Email_Templates.md
new file mode 100644
index 00000000..004b718f
--- /dev/null
+++ b/docs/Email_Templates.md
@@ -0,0 +1,491 @@
+# Email Templates Documentation
+
+This document provides an overview of all email templates used in the PropChain system, including sample payloads, variable references, and preview examples.
+
+## Available Email Templates
+
+### 1. Password Reset Template
+
+**Template File**: `src/email/templates/password-reset.ejs`
+
+**Purpose**: Sent when a user requests a password reset.
+
+**Variables**:
+- `resetUrl` - The password reset link containing the reset token
+
+**Sample Payload**:
+```json
+{
+ "resetUrl": "http://localhost:3000/reset-password?token=abc123xyz789"
+}
+```
+
+**Rendered Preview**:
+```html
+
+
Password Reset Request
+
You have requested to reset your password for your PropChain account.
+
Please click the link below to reset your password:
+
+ Reset Password
+
+
If you didn't request this password reset, please ignore this email.
+
This link will expire in 1 hour for security reasons.
+
Best regards,
The PropChain Team
+
+
Account Locked
+
Your PropChain account has been temporarily locked due to multiple failed login attempts.
+
The lockout will automatically expire in 30 minutes.
+
If you did not attempt to log in, please reset your password immediately or contact our support team.
+
Best regards,
The PropChain Team
+
+
Fraud Alert Triggered
+
Alert ID: fraud-alert-123
+
Pattern: EXCESSIVE_FAILED_LOGINS
+
Severity: HIGH
+
User: user@example.com
+
Summary: The account recorded 10 failed login attempts in the last 30 minutes.
+
+
Transaction Created
+
Your transaction has been successfully created and is now pending.
+
+
Transaction ID: txn-123
+
Property: Modern Downtown Apartment
+
Address: 123 Main St, New York, NY 10001
+
Amount: $500,000
+
Status: PENDING
+
+
You will receive notifications as the transaction progresses.
+
Best regards,
The PropChain Team
+
+
Transaction Completed
+
Congratulations! Your transaction has been successfully completed.
+
+
Transaction ID: txn-123
+
Property: Modern Downtown Apartment
+
Address: 123 Main St, New York, NY 10001
+
Amount: $500,000
+
Completion Date: January 15, 2026
+
Blockchain Hash: 0xabc123...xyz789
+
+
All documents and records have been updated. Thank you for using PropChain.
+
Best regards,
The PropChain Team
+
+
Transaction Cancelled
+
Your transaction has been cancelled.
+
+
Transaction ID: txn-123
+
Property: Modern Downtown Apartment
+
Address: 123 Main St, New York, NY 10001
+
Amount: $500,000
+
Reason: Mutual agreement between parties
+
Cancelled Date: January 10, 2026
+
+
If you have any questions about this cancellation, please contact our support team.
+
Best regards,
The PropChain Team
+
+
Password Reset Request
+
You have requested to reset your password for your PropChain account.
+
Please click the link below to reset your password:
+
+ Reset Password
+
+
If you didn't request this password reset, please ignore this email.
+
This link will expire in 1 hour for security reasons.
+
Best regards,
The PropChain Team
+
+
Transaction Cancelled
+
Your transaction has been cancelled.
+
+
Transaction ID: <%= transactionId %>
+
Property: <%= propertyTitle %>
+
Address: <%= propertyAddress %>
+
Amount: <%= amount %>
+ <% if (cancellationReason) { %>
+
Reason: <%= cancellationReason %>
+ <% } %>
+
Cancelled Date: <%= cancelledDate %>
+
+
If you have any questions about this cancellation, please contact our support team.
+
Best regards,
The PropChain Team
+
+
Transaction Completed
+
Congratulations! Your transaction has been successfully completed.
+
+
Transaction ID: <%= transactionId %>
+
Property: <%= propertyTitle %>
+
Address: <%= propertyAddress %>
+
Amount: <%= amount %>
+
Completion Date: <%= completionDate %>
+ <% if (blockchainTxHash) { %>
+
Blockchain Hash: <%= blockchainTxHash %>
+ <% } %>
+
+
All documents and records have been updated. Thank you for using PropChain.
+
Best regards,
The PropChain Team
+
+
Transaction Created
+
Your transaction has been successfully created and is now pending.
+
+
Transaction ID: <%= transactionId %>
+
Property: <%= propertyTitle %>
+
Address: <%= propertyAddress %>
+
Amount: <%= amount %>
+
Status: <%= status %>
+
+
You will receive notifications as the transaction progresses.
+
Best regards,
The PropChain Team
+
${message}
View your dashboard for details.
`,
- userId: user.id,
- emailType: 'TRANSACTION_UPDATE',
+ await this.emailService.sendTransactionStatusEmail(user.email, transaction.status, {
+ transactionId: transaction.id,
+ propertyTitle: transaction.property.title,
+ propertyAddress: `${transaction.property.address}, ${transaction.property.city}, ${transaction.property.state} ${transaction.property.zipCode}`,
+ buyerName: transaction.buyer.firstName ? `${transaction.buyer.firstName} ${transaction.buyer.lastName || ''}` : transaction.buyer.email,
+ sellerName: transaction.seller.firstName ? `${transaction.seller.firstName} ${transaction.seller.lastName || ''}` : transaction.seller.email,
+ amount: `$${Number(transaction.amount || 0).toLocaleString()}`,
+ completionDate: transaction.status === 'COMPLETED' ? new Date().toLocaleDateString() : undefined,
+ blockchainTxHash: transaction.blockchainTxHash || undefined,
+ cancellationReason: transaction.cancellationReason || undefined,
+ cancelledDate: transaction.status === 'CANCELLED' ? new Date().toLocaleDateString() : undefined,
});
}