DJPoland/CampusQwest-backend

This is the CampusQwest backend and its infrastructure setup

CampusQwest Backend

This repository includes various files that build the backend infrastructure for CampusQwest

Table of Contents

1. Required Software
2. Getting Started
   • Setup
3. Usage
4. Roadmap
5. License

Required Software:

The tools needed for CampusQwest includes:

• Terraform
• AWS CLI
• Python 3
• An operating system that supports shell scripts (UNIX/*NIX environments)

Getting Started

To setup the backend, the steps below will help in accomplishing this task. This assumes the AWS CLI has been configured properly and that terraform and Python 3.8 are installed.

Setup

1. Ensure you have configured the AWS CLI with your AWS account and have the Terraform CLI.
2. Clone the repo and change into the directory ~/CampusQwest-backend/lambdas
3. Set up a virtual environment in Python (Note: Make sure the environment is Python 3.8.*, not 3.9+ due to AWS Lambda runtime support).

   python -m venv venv
   source ./venv/bin/activate

4. Install the Python dependencies

   pip install -r requirements.txt

5. Then use the shell script for generating deployable Lambda functions

   chmod +x create_lambdas.sh
   ./create_lambdas.sh

6. Now head back to the root directory and deploy using the Terraform CLI.

Usage

TODO: Might use this section...

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.