Update setup readme #1134
Update setup readme #1134
Conversation
ztefanie
requested review from
steffenkleinle,
sarahsporck and
f1sh1918
as code owners
docs/development-setup.md
Outdated
| 11. Create an admin account using `./gradlew run --args="create-admin <project> <role> <email> <password> <region>"` | ||
| 12. Take a look at the martin endpoints: [http://localhost:5002/tiles/accepting_stores/index.json](http://localhost:5002/tiles/accepting_stores/index.json) and [http://localhost:5002/tiles/accepting_stores/rpc/index.json](http://localhost:5002/tiles/accepting_stores/rpc/index.json). The data shown on the map is fetched from a hardcoded url and is not using the data from the local martin! | ||
| 13. Take a look at the style by viewing the test map: [http://localhost:5002](http://localhost:5002) | ||
| 14. Take a look at the backend: [http://localhost:8000](http://localhost:8000) (The public version is available at |
There was a problem hiding this comment.
Those links on ports 5002 and 8000 are not working for me. They all return 404 Not found error, except http://localhost:5002/tiles/accepting_stores/rpc/index.json it returns can not parse "accepting_stores" to a i16.
Is this also the case for you? If so, what would be the correct links? If not, how can I fix this?
There was a problem hiding this comment.
Okay, I did some evaluating. So the links currently don't work and that is correct, I guess. I guess @maxammann just forgot to remove them when he updated the ./docker/nginx*.config. As in earlier days there was one config for the development setup and one for staging. Now, there is only one config which is used for both. Therefore, at least that's what I guess what happened here, the map and style and other information have been stripped from nginx and the docs haven't been updated.
It is possible to readd the links. But for that I'd ask @maxammann or @f1sh1918, whether this would have other implications.
There was a problem hiding this comment.
Calling http://localhost:8000 gives the root of the backend that is a 404 currently. This is expected. We could add a route in the backend to return some text or HTML.
A 404 on http://localhost:5002` is also expected. The root of the martin tile server returns a 404.
It is unexpected that getting the tilejson for the accepting stores return an error through this link http://localhost:5002/tiles/accepting_stores/rpc/index.json. I can not make sense of the error without digging deeper or setting it up.
Not sure about the changes in the docker setup. I think the URLs above should work as you need them for a local development setup.
There was a problem hiding this comment.
Then I'll propose a PR to readd support for those links and create another ticket for digging into the issue with http://localhost:5002/tiles/accepting_stores/rpc/index.json
There was a problem hiding this comment.
So i will just add a hint to the docs that it is supposed these urls return a 404 or should I just keep it as it is?
There was a problem hiding this comment.
Keep it as it is, I'll fix it in #1141
There was a problem hiding this comment.
@ztefanie ahh. before I miss it. localhost:8000 is supposed to not work as this port is not even mirrored by docker in the docker compose. So you could just remove 14. ...
docs/development-setup.md
Outdated
| 11. Create an admin account using `./gradlew run --args="create-admin <project> <role> <email> <password> <region>"` | ||
| 12. Take a look at the martin endpoints: [http://localhost:5002/tiles/accepting_stores/index.json](http://localhost:5002/tiles/accepting_stores/index.json) and [http://localhost:5002/tiles/accepting_stores/rpc/index.json](http://localhost:5002/tiles/accepting_stores/rpc/index.json). The data shown on the map is fetched from a hardcoded url and is not using the data from the local martin! | ||
| 13. Take a look at the style by viewing the test map: [http://localhost:5002](http://localhost:5002) | ||
| 14. Take a look at the backend: [http://localhost:8000](http://localhost:8000) (The public version is available at |
There was a problem hiding this comment.
Okay, I did some evaluating. So the links currently don't work and that is correct, I guess. I guess @maxammann just forgot to remove them when he updated the ./docker/nginx*.config. As in earlier days there was one config for the development setup and one for staging. Now, there is only one config which is used for both. Therefore, at least that's what I guess what happened here, the map and style and other information have been stripped from nginx and the docs haven't been updated.
It is possible to readd the links. But for that I'd ask @maxammann or @f1sh1918, whether this would have other implications.
Updated some of the instructions to setup the project