Stack FastAPI ORM Template

This is a Stack FastAPI ORM Template project.

Features

• Stack
• FastAPI
• REST API
• PostgreSQL
• ORM (SQLAlchemy)
• Web service
• Microservice
• Template
• CI/CD
• Docker and docker compose

---

Getting started

1. Prerequisites

• Install docker and docker-compose - https://docs.docker.com/engine/install

For development:

• Install git - https://git-scm.com/downloads
• Setup an SSH key - https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh

2. Download or clone the repository

2.1. Prepare projects directory (if not exists):

# Create projects directory:
mkdir -pv ~/workspaces/projects

# Enter into projects directory:
cd ~/workspaces/projects

2.2. Follow one of the below options [A], [B] or [C]:

A. Clone the repository (for public: git + https):

git clone https://github.com/bybatkhuu/stack.fastapi-orm-template.git && \
    cd stack.fastapi-orm-template

# Or clone with all submodules:
git clone --recursive https://github.com/bybatkhuu/stack.fastapi-orm-template.git && \
    cd stack.fastapi-orm-template && \
    git submodule update --init --recursive && \
    git submodule foreach --recursive git checkout main

B. Clone the repository (for development: git + ssh key):

git clone [email protected]:bybatkhuu/stack.fastapi-orm-template.git && \
    cd stack.fastapi-orm-template

# Or clone with all submodules:
git clone --recursive [email protected]:bybatkhuu/stack.fastapi-orm-template.git && \
    cd stack.fastapi-orm-template && \
    git submodule update --init --recursive && \
    git submodule foreach --recursive git checkout main

C. Download source code: https://github.com/bybatkhuu/stack.fastapi-orm-template/releases

3. Configure environment

TIP: Skip this step, if you've already configured environment.

3.1. Configure .env file:

IMPORTANT: Please, check environment variables!

# Copy '.env.example' file to '.env' file:
cp -v ./.env.example ./.env

# Edit environment variables to fit in your environment:
nano ./.env

3.2. Configure docker-compose.override.yml file:

IMPORTANT: Please, check arguments!

# Set environment:
export _ENV=[ENV]
# For example for development environment:
export _ENV=dev

# Copy 'docker-compose.override.[ENV].yml' file to 'docker-compose.override.yml' file:
cp -v ./templates/docker-compose/docker-compose.override.${_ENV}.yml ./docker-compose.override.yml

# Edit 'docker-compose.override.yml' file to fit in your environment:
nano ./docker-compose.override.yml

3.3. Validate docker compose configuration:

NOTICE: If you get an error or warning, check your configuration files (.env or docker-compose.override.yml).

./compose.sh validate
# Or:
docker compose config

4. Run docker compose

./compose.sh start -l
# Or:
docker compose up -d && \
    docker compose logs -f --tail 100

5. Stop docker compose

./compose.sh stop
# Or:
docker compose down

👍 ✨

---

Environment Variables

You can use the following environment variables to configure:

.env.example

## --- Environment variable --- ##
ENV=local
DEBUG=false


## --- DB configs --- ##
FOT_DB_HOST=db
FOT_DB_PORT=5432
FOT_DB_USERNAME=fot_user
FOT_DB_PASSWORD="fot_password1"
FOT_DB_DATABASE=fot_db
# FOT_DB_DSN_URL="postgresql+psycopg://fot_user:fot_password1@db:5432/fot_db"

# FOT_DB_READ_HOST=db
# FOT_DB_READ_PORT=5432
# FOT_DB_READ_USERNAME=fot_user
# FOT_DB_READ_PASSWORD="fot_password1"
# FOT_DB_READ_DATABASE=fot_db
# FOT_DB_READ_DSN_URL="postgresql+psycopg://fot_user:fot_password1@db:5432/fot_db"


## -- APP configs -- ##
FOT_APP_PORT=8000
FOT_APP_LOGS_DIR="/var/log/rest.fastapi-orm-template"
FOT_APP_DATA_DIR="/var/lib/rest.fastapi-orm-template"

Arguments

You can use the following arguments to configure:

For api service:

-b, --bash, bash, /bin/bash
    Run only bash shell.

For example as in docker-compose.override.yml file:

    command: ["/bin/bash"]
    command: ["-b", "pwd && ls -al && /bin/bash"]
    command: ["-b", "sleep 3 && uvicorn main:app --host=0.0.0.0 --port=${FOT_APP_PORT:-8000} --no-server-header --proxy-headers --forwarded-allow-ips='*' --no-access-log"]

Roadmap

...

---

References

• FastAPI - https://fastapi.tiangolo.com
• PostgreSQL - https://www.postgresql.org
• SQLAlchemy - https://www.sqlalchemy.org
• Docker - https://www.docker.com
• Docker Compose - https://docs.docker.com/compose