Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.03 KB

README.md

File metadata and controls

41 lines (33 loc) · 1.03 KB
Raw

Todo-List FastAPI

This is a local API for creating and updating a Todo-List. The API can be deployed directly on the root OS or through a docker container.

USAGE (Docker):

  1. Clone the repository to your local PC and change directory to the root of the repository:
cd todo-list
  1. Build the docker image:
docker build -t todo-list-app .
  1. Run the docker image:
  1. Run the docker image without mounting the directory as volume:
docker run -it --rm -p 8000:8000 todo-list-app
  1. Run the docker image with mounting the directory as volume. You can make changes directly into the folder and uvicorn will reload upon detecting changes in the files:
docker run -it --rm -p 8000:8000 -v $(pwd):/todo-list todo-list-app

USAGE (CLI):

  1. Clone the repository to your local PC and change directory to the root of the repository:
cd todo-list
  1. Build the docker image:
pip3 install -r requirements.txt
  1. Run the docker image:
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload