FastAPI Backend Project

This Template is a FastAPI backend-only application that uses SQLAlchemy for ORM, RabbitMQ for messaging, and PostgreSQL as the database. The structure is organized to maintain clean separation of concerns and follows best practices for a scalable and maintainable project.

Folder Structure

myproject/
├── src/
│   ├── core/
│   │   ├── __init__.py
│   │   ├── config.py
│   │   ├── security.py
│   │   └── dependencies.py
│   ├── main.py
│   ├── models/
│   │   ├── user.py # sample model, you'll add others below
│   │   └── __init__.py
│   ├── routers/
│   │   ├── user.py
│   │   └── __init__.py
│   ├── schemas/
│   │   ├── user.py
│   │   └── __init__.py
│   ├── services/
│   │   ├── __init__.py
│   │   ├── database.py
│   │   ├── rabbitmq.py
│   │   └── user.py
│   └── utils/
│       ├── __init__.py
│       ├── logger.py
│       ├── common.py
│       └── email.py
├── docker-compose.yml
├── requirements.txt
├── Dockerfile
└── README.md

Explanation of Folder Structure

• src/: Main source directory.
  • core/: Core utilities and configurations.
    • config.py: Configuration settings (e.g., environment variables).
    • security.py: Security-related functions (e.g., password hashing).
    • dependencies.py: Common dependencies to be injected into routes.
  • main.py: The entry point of the FastAPI application.
  • models/: Database models.
    • user.py: Database model for the user entity.
  • routers/: API routers.
    • user.py: API routes for user operations.
  • schemas/: Pydantic schemas for data validation and serialization.
    • user.py: Pydantic schemas for the user entity.
  • services/: Business logic and service layer.
    • database.py: Database connection and session management.
    • rabbitmq.py: RabbitMQ connection and utility functions.
    • user.py: Business logic for user-related operations.
  • utils/: Utility functions and helpers.
    • logger.py: Logging configuration and utilities.
    • common.py: Common utility functions.
    • email.py: Email sending utilities.