Simple Todo App

This is a simple Todo API application built with FastAPI and SQLite.

Features

Create, Read, Update, and Delete Todo items
Health check endpoint
Database migrations using Alembic
SQLite database for data storage

Project Structure

.
├── alembic/             # Database migration files
├── app/                 # Application package
│   ├── database/        # Database configuration and session management
│   ├── models/          # SQLAlchemy ORM models
│   ├── routers/         # API route handlers
│   └── schemas/         # Pydantic models for request/response validation
├── alembic.ini          # Alembic configuration
├── main.py              # Application entry point
└── requirements.txt     # Project dependencies

Installation

Clone the repository:

git clone <repository-url>
cd simpletodoapp

Create a virtual environment and activate it:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install dependencies:

pip install -r requirements.txt

Database Setup

The application uses SQLite as the database. The database file will be created automatically in the following location:

In production: /app/storage/db/db.sqlite
In development: ./storage/db/db.sqlite (relative to the project root)

Run database migrations:

# Make sure you're in the project root directory
alembic upgrade head

Note: If you encounter import errors with Alembic, make sure you're running the command from the project root directory so that the app module can be found.

Running the Application

Start the application with Uvicorn:

uvicorn main:app --reload

The API will be available at http://localhost:8000

API Documentation

Once the application is running, you can access the Swagger UI documentation at:

API Endpoints

Health Check

GET /health: Check the application health status

Todo Endpoints

GET /todos: List all todos
POST /todos: Create a new todo
GET /todos/{todo_id}: Get a specific todo by ID
PATCH /todos/{todo_id}: Update a specific todo
DELETE /todos/{todo_id}: Delete a specific todo

2.3 KiB Raw Permalink Blame History