FastAPI Project Template

Overview

This is a comprehensive FastAPI project template with robust authentication, database configuration, and scalable architecture.

Features

• Async SQLAlchemy with PostgreSQL
• JWT Authentication
• Dependency Injection
• Environment Configuration
• Comprehensive Error Handling
• Modular Project Structure

Prerequisites

• Python 3.10+
• PostgreSQL
• Poetry or pip

Installation

1. Clone the repository

git clone https://your-repo-url.git
cd fastapi-project

2. Create Virtual Environment

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

3. Install Dependencies

pip install -r requirements.txt

4. Set up Environment Variables

• Copy .env.example to .env
• Fill in your configuration details

5. Database Setup

# Create database
createdb fastapi_db

# Run migrations
alembic upgrade head

6. Run Application

uvicorn app.main:app --reload

Testing

pytest

Project Structure

• app/: Main application code
• tests/: Test suite
• migrations/: Database migrations

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.