BingoMaker

Notes

Lambdacism

• build layer for each module

Development

Setup

Please ensure you have the following installed

• uv for project management
• docker
• terraform

git clone https://github.com/cs399f24/BingoMaker
cd BingoMaker
uv sync

Testing

To run tests for the project you can run make test for tests without a LocalStack instance or use make test-full for all tests.

Linting/Formatting

Ruff is used to lint and format the project.

Linting can be done in the following ways

make lint
uv run ruff check
.venv/bin/ruff check

Formatting can be done similarly

make format
uv run ruff format
.venv/bin/ruff format

Development Server

A local development server which listens on 0.0.0.0:8080 can be started via make server

Deployment

Deployment is done via Terraform. the deploy directory contains the necessary terraform files to deploy the application

Deploy

running make remote-deploy will create all the necessary resources in AWS.

After the resources are created, the application will need to be deployed on AWS Amplify.

This is due to a limitation in Terraform where it cannot deploy a Amplify App without a backend. #24720

Destroy

to destroy the resources run make remote-destroy.

API

The API is fully documented according to the OpenAPI 3.0.3 spec in api.yml.