FastTodo

► A simple Todo api created using FastAPI.

Table of Contents

• Overview
• Repository Structure
• Getting Started
  • Setup
  • Tests
• Project Roadmap

---

Overview

► A restful API for creating and managing todos.

Repository Structure

└── FastTodo/
    ├── main.py
    ├── models
    │   ├── all_todos.py
    │   ├── create_todo.py
    │   ├── todo.py
    │   └── todos.py
    └── reqs.txt

Getting Started

System Requirements:

• Python: version 3.*.*

Setup

From source

1. Clone the FastTodo repository:

$ git clone https://github.com/2k4sm/FastTodo

2. Change to the project directory:

$ cd FastTodo

3. Install the dependencies:

$ pip install -r requirements.txt

4. Run FastTodo using the command below:

$ uvicorn main:fastTodo --reload

Tests

Run the test suite using the command below:

$ pytest

---

Project Roadmap

• ► Create All Endpoints
• ► Add basic CI/CD using github actions and docker.
• ► Deploy to a free hosting service.
• ► Migrate to own no-sql database
• ► Add Logging
• ► Add Authentication
• ► Add Rate Limiting

Thanks for using FastTodo.