deploy the app

.env.makefile.example

@@ -0,0 +1,6 @@
+PEM_FILE=<YOUR_PEM_FILE_FOR_SSH&SCP>
+SSH_USER=<YOUR_SSH_USER>
+SSH_HOST=<YOUR_SSH_HOST>
+FILES_TO_COPY="FILE1 FILE2 ... FILEN"
+TARGET_DIR=<PROJECT_ROOT_DIR_IN_DEPLOYMENT_SERVER>
+ANDROID_DIR=<YOUR_MOBILE_APP_ANDROID_BUILD_DIR>

.github/workflows/aws_dev.yml

@@ -0,0 +1,108 @@
+name: Deploy to AWS Dev (Docker Hub + EC2)
+
+on:
+  push:
+    branches: ["development"]
+
+env:
+  AWS_REGION: ${{ secrets.AWS_REGION }}
+  CONTAINER_REPOSITORY: ${{ secrets.CONTAINER_REPOSITORY }}
+  IMAGE_TAG: ${{ github.sha }} #! ??
+  BACKEND_IMAGE_TAG: ${{ secrets.BACKEND_IMAGE }}
+  CLIENT_IMAGE_TAG: ${{ secrets.CLIENT_IMAGE }}
+  NGINX_IMAGE_TAG: ${{ secrets.NGINX_IMAGE }}
+  SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+  SSH_HOST: ${{ secrets.SSH_HOST }}
+  SSH_USER: ${{ secrets.SSH_USER }}
+  PROJECT_DIR: ${{ secrets.PROJECT_DIR }}
+  MYSQL_ROOT_PASSWORD: ${{ secrets.MYSQL_ROOT_PASSWORD }}
+  MYSQL_USER: ${{ secrets.MYSQL_USER }}
+  MYSQL_PASSWORD: ${{ secrets.MYSQL_PASSWORD }}
+  DB_NAME: ${{ secrets.DB_NAME }}
+  DB_HOST: ${{ secrets.DB_HOST }}
+  DB_PORT: ${{ secrets.DB_PORT }}
+  CORS_ALLOWED_ORIGINS: ${{ secrets.CORS_ALLOWED_ORIGINS }}
+  VITE_BACKEND_URL: ${{ secrets.VITE_BACKEND_URL }}
+  VITE_ENABLE_MOCKS: ${{ secrets.VITE_ENABLE_MOCKS }}
+  VITE_LOGGING: ${{ secrets.VITE_LOGGING }}
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    name: Deploy to AWS Dev
+    runs-on: ubuntu-latest
+    environment: development
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Login to Docker Hub
+        id: login-docker-hub
+        run: |
+          echo "${{ secrets.DOCKER_HUB_PASSWORD }}" | docker login -u "${{ secrets.DOCKER_HUB_USERNAME }}" --password-stdin
+
+      - name: Build, tag, and push images to Docker Hub
+        id: build-image
+        run: |
+          docker-compose -f docker-compose.dev.yml build
+          docker push $CONTAINER_REPOSITORY:$BACKEND_IMAGE_TAG
+          docker push $CONTAINER_REPOSITORY:$CLIENT_IMAGE_TAG
+          docker push $CONTAINER_REPOSITORY:$NGINX_IMAGE_TAG
+          echo "image=$CONTAINER_REPOSITORY:$BACKEND_IMAGE_TAG" >> $GITHUB_OUTPUT
+          echo "image=$CONTAINER_REPOSITORY:$CLIENT_IMAGE_TAG" >> $GITHUB_OUTPUT
+          echo "image=$CONTAINER_REPOSITORY:$NGINX_IMAGE_TAG" >> $GITHUB_OUTPUT
+
+      - name: Configure .env.dev file
+        run: |
+          cat >> .env.dev <<END
+          MYSQL_ROOT_PASSWORD=$MYSQL_ROOT_PASSWORD
+          MYSQL_USER=$MYSQL_USER
+          MYSQL_PASSWORD=$MYSQL_PASSWORD
+          DB_NAME=$DB_NAME
+          DB_HOST=$DB_HOST
+          DB_PORT=$DB_PORT
+          CORS_ALLOWED_ORIGINS=$CORS_ALLOWED_ORIGINS
+          VITE_BACKEND_URL=$VITE_BACKEND_URL
+          VITE_ENABLE_MOCKS=$VITE_ENABLE_MOCKS
+          VITE_LOGGING=$VITE_LOGGING
+          END
+
+      - name: Configure SSH
+        run: |
+          mkdir -p ~/.ssh
+          echo "$SSH_PRIVATE_KEY" > ~/.ssh/aws_dev.pem
+          chmod 400 ~/.ssh/aws_dev.pem
+
+      - name: SSH to AWS EC2 and down the containers
+        run: |
+          ssh -i ~/.ssh/aws_dev.pem $SSH_USER@$SSH_HOST << 'ENDSSH'
+          cd $PROJECT_DIR
+          docker-compose -f docker-compose.dev.yml down
+          ENDSSH
+
+      - name: SCP .env.dev and docker-compose.dev.yml to AWS EC2
+        run: |
+          scp -i ~/.ssh/aws_dev.pem \
+          -r $(pwd)/{.env.dev,docker-compose.dev.yml} \
+          $SSH_USER@$SSH_HOST:$PROJECT_DIR
+
+      - name: SSH to AWS EC2 and deploy
+        run: |
+          ssh -i ~/.ssh/aws_dev.pem $SSH_USER@$SSH_HOST << 'ENDSSH'
+          cd $PROJECT_DIR
+          docker pull $CONTAINER_REPOSITORY:$BACKEND_IMAGE_TAG
+          docker pull $CONTAINER_REPOSITORY:$CLIENT_IMAGE_TAG
+          docker pull $CONTAINER_REPOSITORY/$NGINX_IMAGE_TAG
+          docker-compose -f docker-compose.staging.yml up -d
+          docker-compose -f docker-compose.staging.yml exec backend python manage.py migrate --noinput
+          ENDSSH

.gitignore

@@ -1,4 +1,13 @@
 .DS_Store
 
 # Legacy web project
-web/
+web/
+
+.idea/
+
+# Env files
+.env
+.env.dev
+.env.stage
+.env.prod
+.env.makefile

.vscode/settings.json

@@ -0,0 +1,29 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.tslint": "explicit",
+    "source.organizeImports": "explicit",
+    "source.fixAll.ts": "explicit",
+    "source.sortImports": "explicit"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "editor.formatOnSave": true,
+  "tailwindCSS.experimental.classRegex": [
+    ["clsx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)", "cva\\(([^)]*)\\)"]
+  ],
+  "[ignore]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
+  },
+  "[dotenv]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
+  }
+}

Makefile

@@ -0,0 +1,93 @@
+# Load secrets from a .env file (optional)
+ifneq (,$(wildcard .env.makefile))
+	include .env.makefile
+	export
+endif
+
+# variables
+COMPOSE_FILE=docker-compose.dev.yml
+CONTAINER_REPOSITORY=meminseeker/turquiz
+SERVICES=backend client nginx
+
+# Variables from the env file
+PEM_FILE ?= $(PEM_FILE)
+SSH_USER ?= $(SSH_USER)
+SSH_HOST ?= $(SSH_HOST)
+FILES_TO_COPY ?= $(FILES_TO_COPY)
+TARGET_DIR ?= $(TARGET_DIR)
+ANDROID_DIR ?= $(ANDROID_DIR)
+
+# command for building images from dev
+dev-build:
+	docker-compose -f $(COMPOSE_FILE) build
+
+# command for pushing dev images to Docker Hub
+dev-push:
+	@for service in $(SERVICES); do \
+		docker push $(CONTAINER_REPOSITORY):$$service; \
+	done
+
+# command for down containers
+dev-down:
+	@if [ -z "$(PEM_FILE)" ] || [ -z "$(SSH_USER)" ] || [ -z "$(SSH_HOST)" ] || [ -z "$(TARGET_DIR)" ] || [ -z "$(COMPOSE_FILE)" ]; then \
+		echo "Error: Please set PEM_FILE, SSH_USER, SSH_HOST, TARGET_DIR, and COMPOSE_FILE environment variables"; \
+		exit 1; \
+	fi
+	ssh -i $(PEM_FILE) $(SSH_USER)@$(SSH_HOST) \
+	'cd $(TARGET_DIR) || { echo "Failed to change directory to $(TARGET_DIR)"; exit 1; }; \
+	echo "Successfully changed directory to $(TARGET_DIR)"; \
+	~/.docker/cli-plugins/docker-compose -f $(COMPOSE_FILE) down; \
+	exit'
+
+# command for SCP files to a remote server
+dev-scp:
+	@if [ -z "$(PEM_FILE)" ] || [ -z "$(SSH_USER)" ] || [ -z "$(SSH_HOST)" ] || [ -z "$(FILES_TO_COPY)" ] || [ -z "$(TARGET_DIR)" ]; then \
+		echo "Error: Please set PEM_FILE, SSH_USER, SSH_HOST, FILES_TO_COPY, and TARGET_DIR environment variables"; \
+		exit 1; \
+	fi
+	@for file in $(FILES_TO_COPY); do \
+		if [ ! -f $$file ]; then \
+			echo "Error: File $$file does not exist"; \
+			exit 1; \
+		fi; \
+		scp -i $(PEM_FILE) $$file $(SSH_USER)@$(SSH_HOST):$(TARGET_DIR); \
+	done
+
+# command for deployment to a remote server
+dev-up:
+	@if [ -z "$(PEM_FILE)" ] || [ -z "$(SSH_USER)" ] || [ -z "$(SSH_HOST)" ] || [ -z "$(TARGET_DIR)" ] || [ -z "$(COMPOSE_FILE)" ] || [ -z "$(CONTAINER_REPOSITORY)" ] || [ -z "$(SERVICES)" ]; then \
+		echo "Error: Please set PEM_FILE, SSH_USER, SSH_HOST, TARGET_DIR, COMPOSE_FILE, CONTAINER_REPOSITORY, and SERVICES environment variables"; \
+		exit 1; \
+	fi
+	ssh -i $(PEM_FILE) $(SSH_USER)@$(SSH_HOST) \
+	'cd $(TARGET_DIR) || { echo "Failed to change directory to $(TARGET_DIR)"; exit 1; }; \
+	echo "Successfully changed directory to $(TARGET_DIR)"; \
+	docker pull $(CONTAINER_REPOSITORY):backend; \
+	docker pull $(CONTAINER_REPOSITORY):client; \
+	docker pull $(CONTAINER_REPOSITORY):nginx; \
+	~/.docker/cli-plugins/docker-compose -f $(COMPOSE_FILE) up -d; \
+	~/.docker/cli-plugins/docker-compose -f docker-compose.dev.yml exec backend python manage.py migrate --noinput; \
+	exit'
+
+# Composition of the commands
+dev-bp: dev-build dev-push
+dev-dsu: dev-down dev-scp dev-up
+dev-deploy: dev-bp dev-dsu
+
+dev-mobile:
+	@if [ -z "$(ANDROID_DIR)" ]; then \
+		echo "Error: Please set ANDROID_BUILDER_PATH environment variable"; \
+		exit 1; \
+	fi
+	cd $(ANDROID_DIR) && \
+	./gradlew assembleDebug
+
+prod-mobile:
+	@if [ -z "$(ANDROID_DIR)" ]; then \
+		echo "Error: Please set ANDROID_BUILDER_PATH environment variable"; \
+		exit 1; \
+	fi
+	cd $(ANDROID_DIR) && \
+	./gradlew assembleRelease
+
+.PHONY: dev-build dev-push dev-down dev-scp dev-up dev-bp dev-dsu dev-deploy dev-mobile prod-mobile