Merge pull request #983 from hngprojects/dev

merge dev to main

Author: Homoakin619

.dockerignore

@@ -0,0 +1,46 @@
+# Ignore node_modules directory
+node_modules
+
+# Ignore Python virtual environment directories
+venv
+.venv
+
+# Ignore MacOS system files
+.DS_Store
+
+# Ignore Git directories and files
+.git
+.gitignore
+
+# Ignore log files
+*.log
+
+# Ignore temporary files
+*.tmp
+*.swp
+*~
+
+# Ignore build directories
+build/
+dist/
+
+# Ignore compiled Python files
+__pycache__/
+*.pyc
+
+# Ignore Docker-related files (uncomment if needed)
+# Dockerfile
+# docker-compose.yml
+
+# Ignore coverage reports
+coverage/
+*.cover
+
+# Ignore IDE and editor-specific files
+.vscode/
+.idea/
+*.iml
+
+# Ignore test results
+test-output/
+reports/

.env.sample

@@ -10,6 +10,32 @@ MYSQL_DRIVER=
 DB_URL=postgresql://username:password@localhost:5432/test
 SECRET_KEY = ""
 ALGORITHM = HS256
-ACCESS_TOKEN_EXPIRE_MINUTES = 10
-JWT_REFRESH_EXPIRY=5
+ACCESS_TOKEN_EXPIRE_MINUTES = 3000
+JWT_REFRESH_EXPIRY=7
 APP_URL=
+
+GOOGLE_CLIENT_ID=""
+GOOGLE_CLIENT_SECRET=""
+
+FRONTEND_URL='http://127.0.0.1:3000/login-success'
+
+TESTING=''
+
+MAIL_USERNAME=""
+MAIL_PASSWORD=""
+MAIL_FROM="dummy@gmail.com"
+MAIL_PORT=465
+MAIL_SERVER="smtp.gmail.com"
+
+TWILIO_ACCOUNT_SID="MOCK_ACCOUNT_SID"
+TWILIO_AUTH_TOKEN="MOCK_AUTH_TOKEN"
+TWILIO_PHONE_NUMBER="TWILIO_PHONE_NUMBER"
+
+FLUTTERWAVE_SECRET=""
+PAYSTACK_SECRET=""
+
+STRIPE_SECRET_KEY=""
+STRIPE_WEBHOOK_SECRET=""
+
+MAILJET_API_KEY='MAIL JET API KEY'
+MAILJET_API_SECRET='SECRET KEY'

…EQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md .github/PULL_REQUEST_TEMPLATE.md.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE.md .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+name: Dev Deployment
+
+on:
+  # push:
+  #   branches: [dev]
+  #   paths-ignore:
+  #     - "README.md"
+      # - ".github/workflows/**"
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use SSH Action
+        uses: appleboy/ssh-action@v0.1.8
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          script: |
+            cd hng_boilerplate_python_fastapi_web/dev
+            git add .
+            git stash
+            git pull origin dev
+            source venv/bin/activate
+            pip install -r requirements.txt
+            alembic revision --autogenerate
+            alembic upgrade head

.github/workflows/cd.dev.yaml

@@ -0,0 +1,40 @@
+name: Prod Branch Deployment
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - "README.md"
+      - ".github/workflows/**"
+  workflow_dispatch:
+
+jobs:
+  on-success:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Archive application build
+        run: |
+          tar -czf python.tar.gz .
+
+      - name: Copy Artifacts to server
+        run: |
+          sshpass -p ${{ secrets.PASSWORD }} scp -o StrictHostKeyChecking=no python.tar.gz ${{ secrets.USERNAME }}@${{ secrets.HOST }}:/tmp/python
+          rm -f python.tar.gz
+
+      - name: Use SSH Action
+        uses: appleboy/ssh-action@v0.1.8
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          script: |
+            cd backend/python
+            tar -xzf /tmp/python/python.tar.gz -C .
+            rm -f /tmp/python/python.tar.gz
+            source venv/bin/activate
+            pip install -r requirements.txt
+            alembic revision --autogenerate
+            alembic upgrade head

.github/workflows/cd.dev.yml

@@ -1,16 +1,16 @@
 name: Staging Branch Deployment
 
 on:
-  workflow_run:
-    workflows: ["CI"]
-    types:
-      - completed
+  push:
     branches: [staging]
+    paths-ignore:
+      - "README.md"
+      - ".github/workflows/**"
+  workflow_dispatch:
 
 jobs:
-  on-success:
+  deploy:
     runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -22,16 +22,11 @@ jobs:
           username: ${{ secrets.USERNAME }}
           password: ${{ secrets.PASSWORD }}
           script: |
-            cd python/staging_source_code/
+            cd hng_boilerplate_python_fastapi_web/staging
+            git add .
+            git stash
             git pull origin staging
-            source .venv/bin/activate
+            source venv/bin/activate
             pip install -r requirements.txt
-            # alembic upgrade head
-
-            
-
-  on-failure:
-    runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
-    steps:
-      - run: echo 'The triggering workflow failed'
+            alembic revision --autogenerate
+            alembic upgrade head

.github/workflows/cd.prod.yaml

@@ -1,10 +1,11 @@
 name: CI
 
 on:
-  push:
-    branches: [main, staging, dev, devops-main]
   pull_request:
-    branches: [main, staging, dev, devops-main]
+    types: [opened, synchronize, reopened]
+    paths-ignore:
+      - "README.md"
+      # - ".github/workflows/**"
 
 jobs:
   build-and-test:
@@ -14,21 +15,28 @@ jobs:
       postgres:
         image: postgres:latest
         env:
-          POSTGRES_USER: 'username'
+          POSTGRES_USER: "username"
           POSTGRES_PASSWORD: "password"
           POSTGRES_DB: "test"
         ports:
           - 5432:5432
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.9"
-          virtual-environment: venv
+          python-version: "3.10"
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
 
       - name: Install dependencies
         run: |
@@ -50,13 +58,11 @@ jobs:
             exit 1
           fi
 
+      - name: Run migrations
+        run: |
+          alembic revision --autogenerate
+          alembic upgrade head
 
-      # - name: Run migrations
-      #   run: |
-      #     activate
-      #     alembic upgrade head
-
-      # - name: Run tests
-      #   run: |
-      #     activate
-      #     pytest
+      - name: Run tests
+        run: |
+          PYTHONPATH=. pytest

.github/workflows/cd.prod.yml

@@ -0,0 +1,32 @@
+name: PR Deploy
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    
+
+jobs:
+  deploy-pr:
+    environment: 
+      name: preview
+      url: ${{ steps.deploy.outputs.preview-url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout to branch
+        uses: actions/checkout@v4
+      - name: Copy .env.sample to .env
+        run: cp .env.sample .env
+      - id: deploy
+        name: Pull Request Deploy
+        uses: hngprojects/pr-deploy@main
+        with:
+          server_host: ${{ secrets.HOST }}
+          server_username: ${{ secrets.USERNAME }}
+          server_password: ${{ secrets.PASSWORD }}
+          comment: true
+          context: '.'
+          dockerfile: 'Dockerfile'
+          exposed_port: '7001'
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Print Preview Url
+        run: |
+          echo "Preview Url: ${{ steps.deploy.outputs.preview-url }}"