Merge pull request #34 from Real-Dev-Squad/develop

Dev to Main Sync

Author: prakashchoudhary07

.dockerignore

@@ -0,0 +1,34 @@
+# Include any files or directories that you don't want to be copied to your
+# container here (e.g., local build artifacts, temporary files, etc.).
+#
+# For more help, visit the .dockerignore file reference guide at
+# https://docs.docker.com/go/build-context-dockerignore/
+
+**/.DS_Store
+**/__pycache__
+**/.venv
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose.y*ml
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

.env.example

@@ -2,4 +2,37 @@ ENV='DEVELOPMENT'
 SECRET_KEY='unique-secret'
 ALLOWED_HOSTS='localhost,127.0.0.1'
 MONGODB_URI='mongodb://localhost:27017'
-DB_NAME='todo-app'
+DB_NAME='db-name'
+# GOOGLE OAUTH SETTINGS
+GOOGLE_OAUTH_CLIENT_ID="google-client-id"
+GOOGLE_OAUTH_CLIENT_SECRET="client-secret"
+GOOGLE_OAUTH_REDIRECT_URI="http://localhost:8000/v1/auth/google/callback"
+
+PRIVATE_KEY="generate keys and paste here"
+PUBLIC_KEY="generate keys and paste here"
+
+ACCESS_LIFETIME=3600
+REFRESH_LIFETIME=604800
+
+ACCESS_TOKEN_COOKIE_NAME='todo-access'
+REFRESH_TOKEN_COOKIE_NAME='todo-refresh'
+COOKIE_DOMAIN='localhost'
+COOKIE_SECURE='true'
+COOKIE_HTTPONLY=True
+COOKIE_SAMESITE='Strict'
+
+TODO_UI_BASE_URL='http://localhost:3000'
+TODO_UI_REDIRECT_PATH='dashboard'
+TODO_BACKEND_BASE_URL='http://localhost:8000'
+
+CORS_ALLOWED_ORIGINS='http://localhost:3000,http://localhost:8000'
+
+SWAGGER_UI_PATH='/api/schema'
+
+ADMIN_EMAILS =  "[email protected],[email protected]"
+
+POSTGRES_DB=todo_postgres
+POSTGRES_HOST=postgres
+POSTGRES_PASSWORD=todo_password
+POSTGRES_PORT=5432
+POSTGRES_USER=todo_user

.github/workflows/deploy.yml

@@ -0,0 +1,89 @@
+name: Deploy to EC2
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'staging' }}
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: production.Dockerfile
+          platforms: linux/arm64
+          push: true
+          build-args: |
+            ENV=${{ vars.ENV }}
+          tags: |
+            ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:${{ github.sha }}
+            ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:latest
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Deploy to EC2
+        uses: appleboy/ssh-action@v1
+        with:
+          host: ${{ secrets.AWS_EC2_HOST }}
+          username: ${{ secrets.AWS_EC2_USERNAME }}
+          key: ${{ secrets.AWS_EC2_SSH_PRIVATE_KEY }}
+          script: |
+            docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:latest
+            docker stop ${{ github.event.repository.name }}-${{ vars.ENV }} || true
+            docker rm ${{ github.event.repository.name }}-${{ vars.ENV }} || true
+            docker run -d -p ${{ vars.PORT }}:8000 \
+              --name ${{ github.event.repository.name }}-${{ vars.ENV }} \
+              --network=${{ vars.DOCKER_NETWORK }} \
+              -e ENV="${{ vars.ENV }}" \
+              -e SECRET_KEY="${{ secrets.SECRET_KEY }}" \
+              -e DB_NAME="${{ secrets.DB_NAME }}" \
+              -e MONGODB_URI="${{ secrets.MONGODB_URI }}" \
+              -e ALLOWED_HOSTS="${{ vars.ALLOWED_HOSTS }}" \
+              -e GOOGLE_OAUTH_CLIENT_ID="${{ secrets.GOOGLE_OAUTH_CLIENT_ID }}" \
+              -e GOOGLE_OAUTH_CLIENT_SECRET="${{ secrets.GOOGLE_OAUTH_CLIENT_SECRET }}" \
+              -e GOOGLE_OAUTH_REDIRECT_URI="${{ vars.GOOGLE_OAUTH_REDIRECT_URI }}" \
+              -e PUBLIC_KEY="${{ secrets.PUBLIC_KEY }}" \
+              -e PRIVATE_KEY="${{ secrets.PRIVATE_KEY }}" \
+              -e ACCESS_LIFETIME="${{ vars.ACCESS_LIFETIME }}" \
+              -e REFRESH_LIFETIME="${{ vars.REFRESH_LIFETIME }}" \
+              -e ACCESS_TOKEN_COOKIE_NAME="${{ vars.ACCESS_TOKEN_COOKIE_NAME }}" \
+              -e REFRESH_TOKEN_COOKIE_NAME="${{ vars.REFRESH_TOKEN_COOKIE_NAME }}" \
+              -e COOKIE_DOMAIN="${{ vars.COOKIE_DOMAIN }}" \
+              -e COOKIE_SECURE="${{ vars.COOKIE_SECURE }}" \
+              -e COOKIE_HTTPONLY="${{ vars.COOKIE_HTTPONLY }}" \
+              -e COOKIE_SAMESITE="${{ vars.COOKIE_SAMESITE }}" \
+              -e TODO_BACKEND_BASE_URL="${{ vars.TODO_BACKEND_BASE_URL }}" \
+              -e TODO_UI_BASE_URL="${{ vars.TODO_UI_BASE_URL }}" \
+              -e TODO_UI_REDIRECT_PATH="${{ vars.TODO_UI_REDIRECT_PATH }}" \
+              -e CORS_ALLOWED_ORIGINS="${{ vars.CORS_ALLOWED_ORIGINS }}" \
+              -e SWAGGER_UI_PATH="${{ vars.SWAGGER_UI_PATH }}" \
+              -e ADMIN_EMAILS="${{ vars.ADMIN_EMAILS }}" \
+              -e POSTGRES_HOST="${{ secrets.POSTGRES_HOST }}" \
+              -e POSTGRES_PORT="${{ secrets.POSTGRES_PORT }}" \
+              -e POSTGRES_DB="${{ secrets.POSTGRES_DB }}" \
+              -e POSTGRES_USER="${{ secrets.POSTGRES_USER }}" \
+              -e POSTGRES_PASSWORD="${{ secrets.POSTGRES_PASSWORD }}" \
+              -e DUAL_WRITE_ENABLED="${{ vars.DUAL_WRITE_ENABLED }}" \
+              -e DUAL_WRITE_SYNC_MODE="${{ vars.DUAL_WRITE_SYNC_MODE }}" \
+              -e DUAL_WRITE_RETRY_ATTEMPTS="${{ vars.DUAL_WRITE_RETRY_ATTEMPTS }}" \
+              -e DUAL_WRITE_RETRY_DELAY="${{ vars.DUAL_WRITE_RETRY_DELAY }}" \
+              ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}

.github/workflows/test.yml

@@ -7,15 +7,40 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    services:
-      db:
-        image: mongo:latest
-        ports:
-          - 27017:27017
-    
+    if: ${{ !contains(github.event.pull_request.title, '[skip tests]') }}
+
     env:
+      SECRET_KEY: "test-secret-key"
+      ALLOWED_HOSTS: "localhost,127.0.0.1"
       MONGODB_URI: mongodb://db:27017
       DB_NAME: todo-app
+      GOOGLE_OAUTH_CLIENT_ID: "test-client-id"
+      GOOGLE_OAUTH_CLIENT_SECRET: "test-client-secret"
+      GOOGLE_OAUTH_REDIRECT_URI: "http://localhost:8000/v1/auth/google/callback"
+      PRIVATE_KEY: "test-private-key"
+      PUBLIC_KEY: "test-public-key"
+      ACCESS_LIFETIME: "3600"
+      REFRESH_LIFETIME: "604800"
+      ACCESS_TOKEN_COOKIE_NAME: "todo-access"
+      REFRESH_TOKEN_COOKIE_NAME: "todo-refresh"
+      COOKIE_DOMAIN: "localhost"
+      COOKIE_SECURE: "False"
+      COOKIE_HTTPONLY: "True"
+      COOKIE_SAMESITE: "Lax"
+      TODO_UI_BASE_URL: "http://localhost:3000"
+      TODO_UI_REDIRECT_PATH: "dashboard"
+      TODO_BACKEND_BASE_URL: "http://localhost:8000"
+      CORS_ALLOWED_ORIGINS: "http://localhost:3000,http://localhost:8000"
+      ADMIN_EMAILS: "[email protected]"
+      POSTGRES_HOST: "localhost"
+      POSTGRES_PORT: "5432"
+      POSTGRES_DB: "todo-app"
+      POSTGRES_USER: "test-user"
+      POSTGRES_PASSWORD: "test-password"
+      DUAL_WRITE_ENABLED: "True"
+      DUAL_WRITE_SYNC_MODE: "async"
+      DUAL_WRITE_RETRY_ATTEMPTS: "3"
+      DUAL_WRITE_RETRY_DELAY: "5"
 
     steps:
       - name: Checkout code
@@ -24,7 +49,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11.*'
+          python-version: "3.11.*"
 
       - name: Install dependencies
         run: |
@@ -34,6 +59,10 @@ jobs:
         run: |
           ruff check
 
+      - name: Format check
+        run: |
+          ruff format --check
+
       - name: Run tests
         run: |
-          python3.11 manage.py test
+          python3.11 manage.py test

.gitignore

@@ -103,5 +103,7 @@ dmypy.json
 cython_debug/
 
 .ruff_cache
-mongo_data
-logs
+/mongo_data
+/logs
+
+/postgres_data

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Remote Attach (Django in Docker)",
+            "type": "debugpy",
+            "request": "attach",
+            "connect": {
+                "host": "localhost",
+                "port": 5678
+            },
+            "pathMappings": [
+                {
+                    "localRoot": "${workspaceFolder}",
+                    "remoteRoot": "/app"
+                }
+            ],
+            "justMyCode": false,
+            "django": true,
+            "subProcess": false
+        }
+    ]
+}

Dockerfile

@@ -2,7 +2,7 @@
 FROM python:3.12-slim-bookworm
 
 # Set environment variables
-ENV PYTHONUNBUFFERED 1
+ENV PYTHONUNBUFFERED=1
 
 # Set the working directory in the container
 WORKDIR /app

README.Docker.md

@@ -0,0 +1,23 @@
+# Docker Deployment Guide
+
+### Building and running your application
+
+When you're ready, start your application by running:
+`docker compose up --build`.
+
+Your application will be available at http://localhost:8000.
+
+### Deploying your application to the cloud
+
+First, build your image, e.g.: `docker build -t myapp .`.
+If your cloud uses a different CPU architecture than your development
+machine (e.g., you are on a Mac M1 and your cloud provider is amd64),
+you'll want to build the image for that platform, e.g.:
+`docker build --platform=linux/amd64 -t myapp .`.
+
+Then, push it to your registry, e.g. `docker push myregistry.com/myapp`.
+
+Consult Docker’s [getting started guide](https://docs.docker.com/go/get-started-sharing/) for more detail on building and pushing.
+
+### References
+* [Docker's Python guide](https://docs.docker.com/language/python/)