Skip to content

README.md

Latest commit

 

History

History
54 lines (43 loc) · 1.57 KB

README.md

File metadata and controls

54 lines (43 loc) · 1.57 KB
Raw

TaskManager

A lightweight task management API built using FastAPI.

Tech Stack

  • Framework: FastAPI
  • Data Validation: Pydantic
  • Development Server: Uvicorn

Project Structure

  • app/: Contains the application source code.
    • main.py: Entrypoint of the application defining FastAPI routes.
    • crud.py: In-memory storage helper functions (CRUD operations).
    • schemas.py: Pydantic schemas for request validation and response serialization.
    • models.py: Database models (placeholder for future integration).
    • database.py: SQLAlchemy database session setup (placeholder for future integration).
  • requirements.txt: Python dependencies.

Getting Started

1. Prerequisites

Make sure you have Python 3.8+ installed.

2. Set up Virtual Environment

python3 -m venv .venv
source .venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt

4. Run the Application

uvicorn app.main:app --reload

The server will start at http://127.0.0.1:8000.

5. API Documentation

FastAPI provides automatic interactive documentation:

Endpoints

Method Endpoint Description
POST /tasks Create a new task
GET /tasks Get all tasks
GET /tasks/{task_id} Get a specific task by ID
PUT /tasks/{task_id} Update a specific task by ID
DELETE /tasks/{task_id} Delete a specific task by ID