ProjectName

• Description
• Getting Started
  • Prerequisites
  • Install & Run project
• Contributing
  • Code Style
  • Branch naming
• Environment variables
• Project structure

Description

Your project description

Getting Started

Prerequisites

1. Python3
2. PostgreSQL

Install & Run project

1. Clone repo

git clone Your project url

2. Create Python Virtual Environment
3. Install requirements

pip install -r requirements/requirements.txt

4. Create PostgreSQL database
5. Make .env file

touch .env

6. Set env variables
7. Migrate database

# cd src
alembic upgrade head

8. Run project

source venv/bin/activate
python manage.py serve --workers 1

Run tests

1. Install tests requirements

pip install -r requirements/test_requirements.txt

2. Create db with prefix "test_"
3. Run pytest

source venv/bin/activate
pytest

Tests coverage

pytest --cov=app --cov-report=html --cov-config=.coveragerc tests/ 

Contributing

Code style

pep8 FastAPI Best Practices

Branch naming

{username}/{task_short_description}

Environment variables

Variable	Description	Default
DATABASE_URI	PostgreSQL URI	postgresql+asyncpg://postgres@localhost:5432/db_name
BACKEND_CORS_ORIGINS	Frontend	[]
HOST	-	127.0.0.1
PORT	-	8000
DEBUG	-	False

Project structure

Project structure id described here