Skip to content

Introduction

This is a template repo for FastAPI web service projects.

✨ Features

  • FastAPI
  • REST API
  • Web service
  • Microservice
  • Project structure
  • Boilerplate/template
  • Best practices
  • Configuration
  • Tests
  • Build
  • Scripts
  • Examples
  • Documentation
  • CI/CD
  • Docker and docker compose

🧩 Template

  • You can use this template repository as reference to create a new repository with the same structure or clone the repository to start a new project. It will help you to organize your project structure and files. It works out of the box for most REST API service projects.
  • You can customize (remove, modify or add) the files and directories as needed to meet your project requirements.
  • If you want to use the template repository directly, just click the Use this template button and follow the instructions.

  • You can use cookiecutter to generate a new project from cookiecutter branch:

    # Clone the cookiecutter branch:
git clone -b cookiecutter https://github.com/bybatkhuu/rest.fastapi-template.git

# Install cookiecutter:
pip install cookiecutter

# Generate a new project from the cookiecutter template:
cookiecutter -f ./rest.fastapi-template