From cd3b3dcf8a576a5d72104188e0315c22c4cf03af Mon Sep 17 00:00:00 2001 From: philip306 Date: Sat, 1 Aug 2020 14:01:55 -0400 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8dc7f68..5172f23 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,22 @@ This project is a clone of the functionality available at https://countapi.xyz/ ## Documentation Thanks to FastAPI there is swagger/OpenAPI doc endpoints included automatically and after deployment will be available at /docs and /redoc +``` +├── Dockerfile +├── README.md +├── app +│ ├── __init__.py +│ ├── conf +│ │ ├── __init__.py +│ │ └── config.py +│ ├── tests +│ │ ├── __init__.py +│ │ └── test_main.py +│ └── main.py +├── .dockerignore +├── requirements.txt +└── docker-compose.yml +``` ## Deployment @@ -48,21 +64,17 @@ Navigate to http://127.0.0.1:8000 in a browser ### Docker Compose -Using ```docker-compose``` will using the deployment outlined in docker-compose.yml which will deploy a second container with a standard redis image +Using ```docker-compose``` will use the deployment outlined in docker-compose.yml which will deploy a second container with a standard redis image First clone the repo locally ``` git clone https://github.com/philip306/countapi.git ``` -Update config.py to point to your redis host/ip - -```redishost: str = 'redis'``` - From within the count api directory build the docker image ```docker build -t countapi:0.1 .``` -Launch two separate containers with a redis image and a countapi image you just created +Launch two separate containers with a redis image and the countapi image you just created ```docker-compose up```