Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 1.45 KB

README.md

File metadata and controls

93 lines (61 loc) · 1.45 KB
Raw

FastAPI-redis

Fastapi framework template, with basic redis operations.

Integration Build Release

Development

Prerequisitive

Name Version
Python 3.8
pipenv(Python module) 2018.11.26 or up

Environment setup

  1. Initialize environment variable
cp sample.env .env
  1. Initialize Python environment
make init
  1. Enter the environment and start developing
pipenv shell
  1. Start development API service
cd api/
uvicorn app:APP

The server will run at http://127.0.0.1:8000

Formatting

This project uses black and isort for formatting

make format

Linting

This project uses pylint and flake8 for linting

make lint

Testing

This project uses pytest and its extension(pytest-cov) for testing

Deployment

Prerequisitive

Name Version
Docker 19.03.6
docker-compose 1.17.1

Building image

docker-compose build

This will build the image with tag fastapi-template:latest

Deployment step

The service is deployed with docker-compose.

  1. Start containers
docker-compose up

Contribution