Skip to content

mart337i/fastapi-template-basic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FASTAPI-TEMPLATE-BASIC

❯Basic FastApi template


Getting Started

Prerequisites

Before getting started with fastapi-template-basic, ensure your runtime environment meets the following requirements:

  • Programming Language: Python
  • Package Manager: Poetry
  • Container Runtime: Docker

Installation

Install fastapi-template using one of the following methods:

Build from source:

  1. Clone the fastapi-template repository:
❯ git clone https://github.com/mart337i/fastapi-template
  1. Navigate to the project directory:
cd fastapi-template-basic
  1. Install the project dependencies:

Using poetry  

❯ poetry install

Using docker  

❯ docker compose -f docker-stack.yaml up --build

Usage

Run fastapi-template using the following command:

Using Fastapi  

❯ fastapi dev app/main.py 

Using docker  

❯ docker compose -f docker-stack.yaml up --build

License

This project is protected under the MIT License.


Acknowledgments

Thank you to the builders of the following:

  • Fastapi
  • python-dotenv

You made this hobby project possible!