DayagalaNikhil / todo-list-api

A serverless to-do list API, using Python, FastAPI, AWS Lambda and AWS DynamoDB.

To-do List API: A FastAPI CRUD App

This project is a full-stack CRUD app (a todo-list) with a Python FastAPI backend and a NextJS frontend. It is hosted on serverless AWS infrastructure (using Lambda and DynamoDB).

API Folder

The /api folder contains the Python FastAPI code. Run this shell script to build the code into a zip (required for CDK to upload to Lambda):

# Only work on UNIX (Mac/Linux) systems!
./package_for_lambda.sh

This should generate a lambda_function.zip.

Infrastructure Folder

The /todo-infra folder contains the CDK code to deploy all the infrastructure (Lambda function and DynamoDB table) to your AWS account.

You must have AWS CLI configured, and AWS CDK installed on your machine.

First, install the node modules.

npm install

Then run bootstrap if you never used CDK with your account before.

cdk bootstrap

Now you can use this to deploy.

cdk deploy

Frontend Folder

The /todo-site contains the NextJS frontend that interfaces with the CRUD API. If you want to test it with your endpoint, then don't forget to change todoApiEndpoint and userId to your own API (in pages/index.tsx).

Install the node modules.

npm install

Run the development server locally.

npm run dev

Test Folder

This contains the Pytest integration tests you can use to test your endpoint directly. Don't forget to change your ENDPOINT to the one you want to use (in api_integration_test.py).

You can run the test like this (but you have to have pytest installed):

pytest