Adrien/carrramba-encore-rate
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

📝 Add Docs section to the TODO list

Browse Source
This commit is contained in:
Adrien
2024-01-08 23:03:59 +01:00
parent d7bef20ffc
commit eead35f822
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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 capability for the users to pin his/her favorite stops.
- [ ] Add the address to the stop location. - [ ] 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 ## Front-end
- [ ] Add unit tests. - [ ] Add unit tests.