Skip to content

Commit

Permalink
doc: updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
herrera-luis committed Jul 21, 2023
1 parent 06d83f0 commit cc63d85
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,16 @@ cd layered-flask-todo-service/
2. Build and run the app using Docker Compose:

```bash
docker-compose up
docker compose up
```
This command will build the Docker images and start the containers for the TODO App and its associated services (e.g., the database).

3. Access the API at http://localhost:8000/api/v1/todos/ to start using the TODO App.

4. To stop the app and remove the containers, press Ctrl+C in the terminal and then run:

```bash
docker-compose down
docker compose down
```

5. For more information on the API endpoints and how to use them, please refer to the API documentation http://localhost:8000/api/v1/doc/.

![todo](todo.png)
![todos](todos.png)
Binary file removed todo.png
Binary file not shown.
Binary file added todos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cc63d85

Please sign in to comment.