Skip to content

🛠 Installation

1. 📥 Download or clone the repository

1.1. Prepare projects directory (if not exists):

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

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

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

OPTION A. Clone the repository:

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

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

git clone git@github.com:bybatkhuu/rest.fastapi-template.git && \
    cd rest.fastapi-template

OPTION C. Download source code:

  1. Download archived zip or tar.gz file from releases.
  2. Extract it into the projects directory.
  3. Enter into the project directory.

2. 📦 Install dependencies

[TIP] Skip this step, if you're going to use docker runtime

pip install -r ./requirements.txt

# For DEVELOPMENT:
pip install -r ./requirements/requirements.dev.txt