Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 4.55 KB

devWithDocker.md

File metadata and controls

80 lines (52 loc) · 4.55 KB

Transition Docker installation for development

This tutorial is intended towards developers who want to setup Transition inside a Docker container. Any code modification will be applied instantly to the container, so you don't need to rebuild the image each time.

1. Install Docker for desktop if needed

Follow the docker for desktop for instructions to install the docker for desktop application locally.

If you are already familiar with docker and can run container and scripts easily, you don't have to install docker for desktop.

2. Configure the .env.docker file (Optional)

The .env.docker file is required to contain some environment variables that are not yet available through the configuration. It's located at the root of the transition repo.

The default configuration uses OpenStreetMap tiles which don't require any API keys. If you want to use custom raster tiles (such as aerial imagery), you can configure the following variables in the .env.docker file:

CUSTOM_RASTER_TILES_XYZ_URL=https://your-tile-server/{z}/{x}/{y}
CUSTOM_RASTER_TILES_MIN_ZOOM=0
CUSTOM_RASTER_TILES_MAX_ZOOM=22
  • CUSTOM_RASTER_TILES_XYZ_URL: The URL template for your custom raster tiles (required for custom tiles)
  • CUSTOM_RASTER_TILES_MIN_ZOOM: (Optional) Minimum zoom level for the custom tiles. Defaults to 0.
  • CUSTOM_RASTER_TILES_MAX_ZOOM: (Optional) Maximum zoom level for the custom tiles. Defaults to 22.

Note: The map will work without any tile configuration. Custom tiles are optional and can be switched on/off using the layer switcher in the application.

3. Add your custom polygon for your region

In order to have routing data to calculate the routes, the data must be fetched from OpenStreetMap for a given polygon. If you have a geojson file containing the geojson polygon to fetch, add this file to the transition directory. There is an example file in this repo.

It is not required, but if not set, routing won't be able to follow the road network.

If you don't have a .geojson polygon, use the example file.

4. Run for the first time

Some initialization scripts need to be executed on the very first run of Transition, to set up the database and download the road network.

First, launch Transition by opening a Terminal in the transition/ root folder, and by using the command

docker compose -f docker-compose.yml -f docker-dev/docker-compose.override.yml up -d --build

This will first build the app's image (that usually takes a few minutes). Once the command exits, the app has been launched.

Now, with the same terminal you've just opened, run this command to copy your GeoJSON file to the runtime of the app.

Note: If you're using another GeoJSON file than the one provided as an example (examples/polygon_rtl_area.geojson), you need to modify the path specified in the first argument of the command

docker cp ./examples/polygon_rtl_area.geojson transition-transition-www-1:/app/examples/runtime/imports/polygon.geojson

Then, in Docker Desktop, select Containers on the left, then click on transition-transition-www-1 and go to the Terminal tab. Run the following commands.

Note: You can also use docker exec -it transition-transition-www-1 to run these commands without Docker Desktop

yarn setup && yarn migrate

yarn node --max-old-space-size=4096 /app/packages/chaire-lib-backend/lib/scripts/osrm/downloadOsmNetworkData.task.js --polygon-file /app/examples/runtime/imports/polygon.geojson

For the following command, you will need to choose the transportation types you'd like to import. You should ideally at least select walking, driving and bus_urban, but it's not essential for running the app.

yarn node --max-old-space-size=4096 /app/packages/chaire-lib-backend/lib/scripts/osrm/prepareOsmNetworkData.task.js

Finally, in the same terminal, create your transition user. Run this command and follow the instructions.

yarn create-user

The setup is now complete. To finish the configuration, you need to restart the app. You can either use the stop/play buttons in Docker Desktop, or run docker compose -f docker-compose.yml -f docker-dev/docker-compose.override.yml restart in your terminal.

4.1 Run the application

Once the app is setup, you only need to run docker compose -f docker-compose.yml -f docker-dev/docker-compose.override.yml up to launch it. If you make code changes, the app should rebuild itself automatically.