Based on my experience to run the type-api using the docker compose file (which was really easy) I found a typo in the compose file and two things in the documentation that I found misleading. I “fixed” this based on what I think was meant, but you definitely need to check if it makes sense.
About the typo: The docker compose setup worked without fixing the typo. Which was confusing at first, but I saw the api key is also set to "xyz" in the application.properties, so it makes sense it worked.
About the README file: The docker-compose command has been deprecated for a while, and I believe it was left unmaintained in 2023, so one should use the new docker compose sub-command instead. Therefore, I thought it is probably a good idea not to use the old command in the README, although I am not sure if the docker-compose command is a redirection in the meanwhile.
I enabled the modification of the branch by maintainers, so you can simply push on the branch. This should make corrections easy :)
Based on my experience to run the type-api using the docker compose file (which was really easy) I found a typo in the compose file and two things in the documentation that I found misleading. I “fixed” this based on what I think was meant, but you definitely need to check if it makes sense.
About the typo: The docker compose setup worked without fixing the typo. Which was confusing at first, but I saw the api key is also set to "xyz" in the
application.properties, so it makes sense it worked.About the README file: The
docker-composecommand has been deprecated for a while, and I believe it was left unmaintained in 2023, so one should use the newdocker composesub-command instead. Therefore, I thought it is probably a good idea not to use the old command in the README, although I am not sure if the docker-compose command is a redirection in the meanwhile.I enabled the modification of the branch by maintainers, so you can simply push on the branch. This should make corrections easy :)