SPARCS Email Service

A serverless Email Service with SQS and Twillio SendGrid

Setup Local Environment

1. Pre-requisites:

   • Ensure Python 3.8 is installed

2. Install pipenv:

   pip install pipenv==2023.4.29 --user

3. Install Python Dependencies:

   pipenv install

4. Activate Virtual Environment:

   pipenv shell

5. Add Environment Variables:

   • Add the .env file provided to you in the backend directory

Run Locally

1. Activate Virtual Environment:

   pipenv shell

2. Start Local Server:

   uvicorn main:app --reload --log-level debug --env-file .env

Setup AWS CLI

1. Download and Install AWS CLI:

   • AWS CLI Installation Guide

2. Create AWS Profile:

   aws configure --profile sparcs

   • Input your AWS Access Key ID and AWS Secret Access Key provided to you.
   • Input ap-southeast-1 for the default region name.
   • Leave blank for the default output format.

Setup Serverless Framework

1. Pre-requisites:

   • Ensure Node 14 or later is installed

2. Install serverless framework:

   npm install -g serverless

3. Install serverless plugins:

   npm install

Deploy to AWS

serverless deploy --stage 'dev' --aws-profile 'sparcs' --verbose

Resources

• FastAPI
• Serverless Framework Documentation
• Clean Coder Blog