Skip to content

FastAPI Boilerplate: A starter project for web applications using FastAPI framework, featuring high-performance HTTP server, dependency management with Poetry, Docker development setup, and sample endpoints.

License

Notifications You must be signed in to change notification settings

Trusted97/fast-api-boilerplate

Repository files navigation

🐍 FastAPI Boilerplate

CI Python Version FastAPI Version License Maintainability

This is a boilerplate project to quickly start a web application using the FastAPI framework.

Features

  • High-performance HTTP server based on FastAPI.
  • Dependency management using Poetry.
  • Docker setup for the development environment.
  • Sample FastAPI endpoint to get started.

Requirements

  • Python 3.9 or higher.

Getting Started

  1. Clone this repository:

     git clone https://github.com/Trusted97/fast-api-boilerplate.git
     cd fast-api-boilerplate
    
  2. Run the development server using Docker:

     docker-compose up --build -d
    
  3. Access the FastAPI application: Open your web browser and go to http:https://localhost:8000

  4. Access the Swagger documentation at http:https://localhost:8000/docs to interact with the API.

Project Structure

  • router.py: Sample FastAPI application and endpoint.
  • pyproject.toml: Project configuration and dependencies managed by Poetry.
  • docker/dev/Dockerfile: Docker configuration for the development environment.

Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

License

This project is licensed under the MIT License.

About

FastAPI Boilerplate: A starter project for web applications using FastAPI framework, featuring high-performance HTTP server, dependency management with Poetry, Docker development setup, and sample endpoints.

Resources

License

Code of conduct

Stars

Watchers

Forks