diff --git a/README.md b/README.md index d6f27e3..e3598cf 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,16 @@ transport operators in Ile-de-France. These specifications are public and availa - [ ] Add the capability for the users to pin his/her favorite stops. - [ ] Add the address to the stop location. +## Docs + +- [ ] Describe how to build the front-end and back-end docker images. +- [ ] Describe how to deploy them using `docker compose`. +- [ ] Add back-end API description ([openAPI](https://www.openapis.org/)) + generate documentation + ([mkdoc](https://www.mkdocs.org/), [Redoc](https://github.com/Redocly/redoc)). The best would be to build and + deploy it (as docker images) using CI/CD... need to test [Agola](https://agola.io/), [Jaypore + CI](https://www.jayporeci.in/) (pipelines configured in Python), + [Woodpecker](https://woodpecker-ci.org/docs/intro) or [Drone](https://www.drone.io/) before. + ## Front-end - [ ] Add unit tests.