fastapi-fullstack-boilerplate - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #golang #deep-learning #nodejs #macos #java #windows #cli #openai #open-source

fastapi-fullstack-boilerplate

(★ 112)

A full stack (monolith) boilerplate for FastAPI

File Explorer

Download Latest Version (.zip)

- - __init__.py
  - crud.py
- - __init__.py
  - user_service.py
- - home.html
- __init__.py
- admin.py
- database.py
- dependencies.py
- main.py
- model.py
- settings.py
- index.md
- - 20211002__84aff539fd9a_initial.py
- env.py
- README
- script.py.mako
.env.example
.gitignore
alembic.ini
docker-compose.yaml
LICENSE
Pipfile
Pipfile.lock
README.md

# Installation Guide

1. Get the code

git clone https://github.com/tmkontra/fastapi-fullstack-boilerplate

Downloads the entire project code from GitHub to your computer.

cd fastapi-fullstack-boilerplate

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pipenv install

Type this command into your terminal and run it.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FastAPI Full-Stack Boilerplate

## Features

1. All the goodness of modern, async FastAPI
2. Seamless Jinja2 templating, just like Flask
3. SQLAlchemy ORM and Alembic migrations (PostgreSQL)
4. Flask-Admin plugged right in
5. Pipenv for python dependency management

Explore the [full docs here](./docs/index.md)

## Get Started

1. Copy `.env.example` to `.env` (or create your own)
2. `docker-compose up -d` to start the database
3. `pipenv shell`
4. `FASTAPI_STATICDIGEST_RELOAD=1 uvicorn app.main:create_app --port=8080 --reload`

### Configuration

- Change the database configuration/credentials in `.env` and `docker-compose.yaml`
 - Set `DEBUG_ADMIN=1` to disable the authorization for the admin panel

## Why?

The dependency-injection provided by FastAPI is such a huge improvement over any other python web framework. It's OpenAPI integration is excellent, and it's `asgi`-first, unlike Flask or Django.

But Django is famous for its admin panel, and the ability to rapidly build server side applications. For this, we include Flask-Admin, and centralied Jinja2 templates as a dependency.

## Built On

- FastAPI
- [fastapi-utils class-based-view](https://fastapi-utils.davidmontague.xyz/user-guide/class-based-views/)
- [cookiecutter-flask CRUD mixin](https://github.com/cookiecutter-flask/cookiecutter-flask)
- [Flask-Admin](https://flask-admin.readthedocs.io/en/latest/)