Giter Club home page Giter Club logo

todo-list-api's Introduction

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).

Task API app

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

todo-list-api's People

Contributors

pixegami avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.