Deploying on AWS Cloud

The DevStarter backend can be deployed to any cloud service, but we here explore one of the simplest ways to deploy i.e using Elastic Beanstalk on AWS cloud since AWS gives a generous free tier so it’s easy and cost efficient to deploy.

looking for more ways to deploy?

we are also working on adding more deployment options namely EKS, ECS, Google Cloud Run etc and would update the documentation soon meanwhile you can look at any standard Django deployment guide and it would work fine for you

To deploy your backend APP on EBS go to Github and in the repository secrets add all the environment variables.

use SSM

since we wanted to build a Cloud Agnostic Boilerplate hence we did not configure a AWS Secrets Manager but it’s recommended to use it if you’re using AWS for deployment since it helps managing the Env easily.

the github actions workflow below can be triggered on preffered deployment branch from git (main) and it would built the already existing docker file and upload to S3 -> which would deploy the image on EBS:

go to AWS EBS and create a new EBS environment.

name: Docker Image CI

on:
  push:
    branches: [ main ]

jobs:

  build:
    runs-on: ubuntu-latest
    steps:
    - name: download source code
      uses: actions/checkout@v2

    - name: set environment variables in .env file
      run: |
           echo DAJNGO_SECRET_KEY="${{ secrets.DAJNGO_SECRET_KEY }}" >> .env
          echo DJANGO_DEBUG="${{ secrets.DJANGO_DEBUG }}" >> .env
          echo POSTGRESS_DB_NAME="${{ secrets.POSTGRESS_DB_NAME }}" >> .env
          echo POSTGRESS_USER="${{ secrets.POSTGRESS_USER }}" >> .env
          echo POSTGRESS_PASSWORD="${{ secrets.POSTGRESS_PASSWORD }}" >> .env
          echo POSTGRESS_HOST="${{ secrets.POSTGRESS_HOST }}" >> .env
          echo STRIPE_WEBHOOK_SECRET_LIVE="${{ secrets.STRIPE_WEBHOOK_SECRET_LIVE }}" >> .env
          echo STRIPE_PUBLISHABLE_KEY="${{ secrets.STRIPE_PUBLISHABLE_KEY }}" >> .env
          echo FRONTEND_SITE_URL="${{ secrets.FRONTEND_SITE_URL }}" >> .env
          echo PAYMENT_SUCCESS_URL="${{ secrets.PAYMENT_SUCCESS_URL }}" >> .env
          echo PAYMENT_FAILURE_URL="${{ secrets.PAYMENT_FAILURE_URL }}" >> .env
          echo JWT_AUTH_SECRET="${{ secrets.JWT_AUTH_SECRET }}" >> .env
          echo JWT_AUTH_ALGORITHM="${{ secrets.JWT_AUTH_ALGORITHM }}" >> .env
          echo DJANGO_SETTINGS_MODULE="${{ secrets.DJANGO_SETTINGS_MODULE }}" >> .env
          echo GOOGLE_OAUTH2_CLIENT_ID="${{ secrets.GOOGLE_OAUTH2_CLIENT_ID }}" >> .env
          echo GOOGLE_OAUTH2_CLIENT_SECRET="${{ secrets.GOOGLE_OAUTH2_CLIENT_SECRET }}" >> .env
          echo GOOGLE_REDIRECT_URI="${{ secrets.GOOGLE_REDIRECT_URI }}" >> .env
          echo DEFAULT_USER_AVATAR="${{ secrets.DEFAULT_USER_AVATAR }}" >> .env
          echo VERIFY_EMAIL_ON_SIGNUP="${{ secrets.VERIFY_EMAIL_ON_SIGNUP }}" >> .env
          echo EMAIL_BACKEND="${{ secrets.EMAIL_BACKEND }}" >> .env
          echo EMAIL_HOST="${{ secrets.EMAIL_HOST }}" >> .env
          echo EMAIL_HOST_USER="${{ secrets.EMAIL_HOST_USER }}" >> .env
          echo EMAIL_HOST_PASSWORD="${{ secrets.EMAIL_HOST_PASSWORD }}" >> .env
          echo SENTRY_DSN="${{ secrets.SENTRY_DSN }}" >> .env
          echo COMPANY_NAME="${{ secrets.COMPANY_NAME }}" >> .env
          echo EMAIL_VERIFICATION_REDIRECT_URI="${{ secrets.EMAIL_VERIFICATION_REDIRECT_URI }}" >> .env
          echo AUTH_TOKEN_EXPIRY_DAYS="${{ secrets.AUTH_TOKEN_EXPIRY_DAYS }}" >> .env
          echo ADMIN_EMAIL="${{ secrets.ADMIN_EMAIL }}" >> .env
          echo BEEHIV_API_KEY="${{ secrets.BEEHIV_API_KEY }}" >> .env
          echo BEEHIV_PUBLICATION_ID="${{ secrets.BEEHIV_PUBLICATION_ID }}" >> .env
          echo RECAPTCHA_SECRET_KEY="${{ secrets.RECAPTCHA_SECRET_KEY }}" >> .env
          echo BREVO_API_KEY="${{ secrets.BREVO_API_KEY }}" >> .env
          echo USE_S3="${{ secrets.USE_S3 }}" >> .env
          echo MEDIA_ROOT="${{ secrets.MEDIA_ROOT }}" >> .env
          echo AWS_SECRET_ACCESS_KEY="${{ secrets.AWS_SECRET_ACCESS_KEY }}" >> .env
          echo AWS_REGION_NAME="${{ secrets.AWS_REGION_NAME }}" >> .env
          echo AWS_BUCKET_NAME="${{ secrets.AWS_BUCKET_NAME }}" >> .env


    - name: Build the Docker image
      run:  |
        ls
        docker build -t the_dev_starter_api .
    -
      name: Generate Deployment Package
      run: zip -r deploy.zip * .env*
    -
      name: Get timestamp
      uses: gerred/actions/current-time@master
      id: current-time

    - name: Run string replace
      uses: frabert/replace-string-action@master
      id: format-time
      with:
        pattern: '[:\.]+'
        string: "${{ steps.current-time.outputs.time }}"
        replace-with: '-'
        flags: 'g'


    - name: Deploy to EB
      uses: einaregilsson/beanstalk-deploy@v14
      with:
        aws_access_key: ${{ secrets.AWS_ACCESS_KEY_ID }}
        aws_secret_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        application_name: <EBS application Name>
        environment_name: <EBS Application Env>
        version_label: "the-dev-starter-${{ steps.format-time.outputs.replaced }}"
        region: us-east-1
        deployment_package: deploy.zip