FastAPI Boilerplate - Industry Standard

Introduction

Welcome to the FastAPI Boilerplate repository. This project serves as a launching pad for building high-performance, scalable web APIs that conform to industry standards. My boilerplate incorporates the best practices of modern web development, ensuring that your application is not only fast and efficient but also maintainable and secure.

Why FastAPI Boilerplate?

Modern web applications demand modern solutions. FastAPI is a contemporary framework that offers high performance, easy-to-build APIs with automatic interactive documentation. My boilerplate is designed to help you jumpstart your project without the hassle of setting up the foundational elements from scratch.

Features

• Asynchronous Support: Harness the full power of async programming to handle a large number of requests simultaneously.
• Containerization with Docker: Package your application with all its dependencies in a Docker container.
• ORM with SQLAlchemy: Interact with databases easily with the SQLAlchemy ORM integrated into the boilerplate.
• Automatic Migration with Alembic: Keep your database schema in sync with your models through Alembic migrations.
• Secure Authentication: Built-in OAuth2 password and bearer with JWT tokens for secure and stateless authentication.
• Dependency Management with Pipenv: Manage your dependencies and environment with the robust packaging tool, Pipenv.

Getting Started

Prerequisites

• Python 3.6+
• Docker
• Pipenv

Project Structure & Guide

Installation

1. Clone the Repository

   git clone https://github.com/joeygoesgrey/FASTAPI-BOILERPLATE.git

2. Navigate to the Project Directory

   After cloning the repository, navigate to the project directory:

   cd FASTAPI-BOILERPLATE

3. Install Dependencies

   Install the necessary dependencies using Pipenv:

   pipenv install

4. Set Environment Variables

   Configure your environment variables by updating them with your specific settings.

5. Run with Docker Compose

   Build and start the services using Docker Compose:

   docker-compose up --build

6. Perform Database Migrations

   Initialize your database and perform migrations with the following command:

   pipenv run alembic upgrade head

7. Start the FastAPI Server

   Your application will be accessible at http://localhost:8080, and the API documentation can be found at http://localhost:8080/docs.

   pipenv run python3 main.py --env dev

Contributing

We welcome contributions from the community. If you'd like to contribute, please fork the repository, make your changes, and submit a pull request.

License

This project is open-sourced under the MIT License. For more details, see the LICENSE.md file in this repository.

Happy Coding!