fastApiCleanArchitecture

Installation

• You can also open a shell inside virtual environment:

  make shell

• Install all the project dependency using Pipenv:

  make install

• Run the application from command prompt:

  make dev

• Clean

  make clean

• Open localhost:8000/docs for API Documentation

Testing commands

• Run tests:

  make tests

• Run Coverage Report:

  make cov

Format commands

• Check the code style:

  make check

• Format the code:

  make format

Docker commands

• Create requirements.txt with pipenv

  make requirements

• Create a new docker image

  make docker_image

• Run the API in a local container

  make docker_run

• Deploy the docker image in docker hub

  make docker_push

Kubernetes commands

• Start kubernetes

  make kube_start

• Deploy changes of kubernetes.yaml

  make kube_deploy

• Access the api in kubernetes

  make kube_access

• Access kubernetes dashboard

  make kube_dash

License

© MIT License