📝 Flow Todo Backend

A lightweight, modular FastAPI backend for managing Todo items.
Built with Poetry, SQLAlchemy, Pydantic, and Alembic, following a clean, scalable project structure.
This backend powers the Flow mobile app.

---

🚀 Features

• ⚡ FastAPI-based REST API
• 🗄️ SQLAlchemy ORM + Alembic migrations
• 📦 Pydantic request/response models
• 🛠️ Modular routing (versioned API)
• ✅ CRUD endpoints for Todo items
• 🚀 Ready for deployment (Uvicorn / Gunicorn)
• 📦 Poetry for dependency & environment management
• 🧩 Clear project layout to ease extension and DB integration
• 🧪 Tests with pytest

---

🛠️ Tech Stack

• 🐍 Python 3.10+
• ⚡ FastAPI
• 🗄️ SQLAlchemy
• 🔄 Alembic
• 📦 Pydantic
• 📦 Poetry
• 📝 SQLite / PostgreSQL (future-ready)

---

📁 Project Structure

flow_backend/
├── alembic
│ ├── env.py
│ ├── README
│ ├── script.py.mako
│ └── versions/
├── alembic.ini
├── app
│ ├── **init**.py
│ ├── api
│ │ ├── **init**.py
│ │ └── v1
│ │ ├── endpoints
│ │ │ ├── **init**.py
│ │ │ └── todo.py
│ │ └── router.py
│ ├── core
│ │ ├── **init**.py
│ │ ├── config.py # Settings, ENV, JWT config
│ │ └── security.py # JWT create/verify, password hashing
│ ├── db
│ │ ├── **init**.py
│ │ ├── base.py # Base metadata (SQLAlchemy models import)
│ │ └── session.py # SessionLocal, engine
│ ├── main.py # FastAPI initialization, include router
│ ├── models
│ │ ├── **init**.py
│ │ └── todo.py # SQLAlchemy model
│ ├── schemas
│ │ ├── todo.py
│ │ └── todos_response.py
│ └── utils
│ ├── **init**.py
│ └── logger.py # Logging utility
├── LICENSE
├── poetry.lock
├── pyproject.toml
└── README.md

---

⚡ Prerequisites (macOS)

• 🐍 Python 3.10+ (or compatible)
• 🔧 git
• 🛠️ Optional: virtualenv / venv

---

🏁 Quick Start (macOS)

1. Clone and enter project

git clone <repo-url>
cd flow_backend

2. Install Poetry

pip install poetry

3. Install dependencies & activate virtual environment

poetry install
poetry shell

4. Run the development server

uvicorn app.main:app --reload

# Adjust module path if your entrypoint differs

5. Open the interactive docs

• 🖥️ Swagger UI: http://127.0.0.1:8000/docs
• 📑 ReDoc: http://127.0.0.1:8000/redoc

---

📡 API Endpoints (typical)

• GET /todos — list todos
• POST /todos — create a todo
• GET /todos/{id} — get todo by id
• PUT /todos/{id} — update todo
• DELETE /todos/{id} — delete todo

Example: Create a Todo

curl -X POST http://127.0.0.1:8000/todos \
 -H "Content-Type: application/json" \
 -d '{"title":"Buy milk","completed":false}'

---

🧪 Tests

Run unit tests:

pytest -q

---

🤝 Contributing

• 🐛 Open issues for bugs or enhancements
• 📝 Submit focused PRs
• 🎨 Ensure code is formatted (black, isort recommended)

---

📄 License

MIT License — see LICENSE