This is the repository of the french National Access Point (NAP) for mobility data.
This project brings a mobility focus on data hosted on data.gouv.fr, the french open data portal.
You will find user documentation at doc.transport.data.gouv.fr.
A status dashboard is available at https://stats.uptimerobot.com/q7nqyiO9yQ for a part of the project.
A small glossary explaining the various terms can be found in this repo (glossary.md). Please feel free to add any term which appears initially foreign there.
You can install this 2 different ways:
- manually, this is the best way to install it if you plan to work often on the project.
- with docker, this is an easier installation process at the cost of a slightly more cumbersome development workflow.
- Make sure you have Elixir, Node, Yarn and Docker installed and up-to-date
- Elixir is often installed with asdf since it makes it easy to handle different Elixir versions accross projects. The project needs at least Elixir 1.8 and Erlang 21.0
- Install Elixir dependencies with
- Install Node.js dependencies with
mix yarn install
If you wish to use
asdf (recommended), make sure to install the correct plugins:
asdf plugin-add erlang(https://github.com/asdf-vm/asdf-erlang)
asdf plugin-add elixir(https://github.com/asdf-vm/asdf-elixir)
asdf plugin-add nodejs(https://github.com/asdf-vm/asdf-nodejs)
Installation can then be done with:
You also need an up to date postgresql with postgis installed. Version 12+ is recommended.
For Mac users, you can use https://postgresapp.com/.
Download depencies using
Reply "Yes" to the question "Shall I install Hex? (if running non-interactively, use "mix local.hex --force")".
Creating a database
Create the database with the command
Alternatively, you can create it manually. With the permission to create a database (on Debian based system, you need to be logged as
Applying the migrations
To have an up to date database schema run
Restoring the production database
The production database does not contains any sensitive data, you can retreive it for dev purpose.
- You can retrieve the latest clever-cloud backup (you need some permissions to access it, if you don't have them, you can ask someone on the team to give you the database)
- On the clever-cloud website, under transport-site-postgresql, there is a Backups section with download links.
- restore the downloaded backup on you database:
Binary CLI dependencies
The app uses a number of tools via transport-tools.
They are expected at
./transport-tools by default (but this can be configured via
When working locally, you may want to have these tools readily available at times.
mkdir transport-tools cd transport-tools # jars are cross-platform, so we can copy them from the container (see `transport-tools` repository for exact naming) # here we share the host folder `transport-site/transport-tools` with a folder inside the container named `/tmp-docker-folder`, # in order to copy back the exact same jars we use in production docker run --rm -v $(pwd):/tmp-docker-folder ghcr.io/etalab/transport-tools:latest /bin/sh -c "cp /usr/local/bin/*.jar /tmp-docker-folder"
For Rust binaries, you will have to compile them locally and copy them to the same folder.
Once this is done, make sure to configure your configuration via
Run the server with
mix phx.server and you can visit
127.0.0.1:5000 on your browser.
Usage of the Elixir Proxy
apps/unlock is a sub-part of the "umbrella app", which is served on its own subdomain (https://proxy.transport.data.gouv.fr for production, https://proxy.prochainement.transport.data.gouv.fr/ for staging).
The proxy relies on this yaml configuration which is currently fetched at runtime once (but can be hot-reloaded via this backoffice page).
Each proxied "feed" (currently GTFS-RT data) has a private (target) url hidden from the general public, can be configured with an independent Time-To-Live (TTL), and is exposed as a credential-free public url to the public. When a query occurs, the incoming HTTP connection is kept on hold while the proxy issues a query to the target server, caching the response in RAM based on the configured TTL.
The backoffice implementation leverages LiveView to provide an automatically updated dashboard view with all the feeds, the size of the latest payload, the latest HTTP code returned by the target etc. Implementation is here.
When working in development, instead of fetching the configuration from GitHub, the configuration is taken from a local config file (
config/proxy-config.yml, see config), in order to make it very easy to play with sample configurations locally.
For local work, you will have (for now at least) to add
proxy.localhost 127.0.0.1 to your
The app currently routes whatever starts with
proxy. to the proxy (as implemented here), although in the future we will probably use a more explicit configuration.
Configuring OAuth to work with demo.data.gouv.fr
By default the development configuration is very simple and only allows the most basic scenarios.
If you need to login via
demo.data.gouv.fr, follow these steps:
- Create or edit
config :oauth2, Datagouvfr.Authentication, # go to CleverCloud staging site and pick `DATAGOUVFR_CLIENT_ID` client_id: "TODO-REPLACE", # same but use `DATAGOUVFR_CLIENT_SECRET` client_secret: "TODO-REPLACE"
Then make sure to restart the app.
The rest of the configuration is already set via
config :oauth2, Datagouvfr.Authentication, # SNIP site: "https://demo.data.gouv.fr", redirect_uri: "http://localhost:5000/login/callback"
Running the tests
Run the tests with
The application is an umbrella app. It means that it is split into several sub-projects (that you can see under
To run tests for a specific app, for example the
gbfs app, use this command:
# for apps/transport app mix cmd --app transport mix test --color # for apps/gbfs mix cmd --app gbfs mix test --color # or, for a single file, or single test mix cmd --app transport mix test --color test/transport_web/integrations/backoffice_test.exs mix cmd --app transport mix test --color test/transport_web/integrations/backoffice_test.exs:8
The filenames must be relative to the app folder. This will be improved when we upgrade to a more modern Elixir version.
Measuring test coverage
We use excoveralls to measure which parts of the code are covered by testing (or not). This is useful to determine where we can improve the testing quality.
The following commands will launch the test and generate coverage:
# Display overall (whole app) coverage for all tests in the console MIX_ENV=test mix coveralls --umbrella # Same with a HTML report MIX_ENV=test mix coveralls.html --umbrella # Display coverage for each umbrella component, rather MIX_ENV=test mix coveralls
The coverage is written on screen by default, or in the
cover subfolders for HTML output.
--umbrella mode will generate coverage report at the top-level
cover folder, while running without it will generate reports under each umbrella sub-app (e.g.
- Run the elixir linter with
mix credo --strict
mix npm "run linter:ecma"
- Run the sass linter with
mix npm "run linter:sass"
Misc Elixir command
To extract all translations from the source, you can run
mix gettext.extract --merge (and then edit the modified .po files).
To perform all the checks done on the CI with a single command, you can run
mix check_all. It will run the different linters, credo, check the translations are up-to-date, and launch the tests.
To generate a new migration file:
cd apps/transport && mix ecto.gen.migration <name of the migration> && cd ../..
The generated ecto migration file will be
apps/transport/priv/repo/migrations/<timestamp>_<name of the migration>.exs
To apply all migrations on you database:
One shot tasks
Some custom one shot tasks are available.
To run a custom task:
mix <custom task>
Transport.ImportAom: import the aom data from the cerema
Transport.ImportEPCI: import the french EPCI from data.gouv
Transport.OpenApiSpec: generate an OpenAPI specification file
If you don't plan to work a lot on this project, the docker installation is way easier.
You need a .env file, and can use .env.example to see which variables need to be set.
(No need to setup the variable
PG_URL, it is defined in the docker-compose.yml)
Then you only need to run:
And access it at http://localhost:5000
You can make changes in the repository and those will be applied with hot reload.
You can run any
mix command with:
docker-compose run web mix <cmd>
For the tests you also need to add an environment variable:
docker-compose run -e web mix test
The Dockerfile needed to run the continuous integration is in the project: https://github.com/etalab/transport-ops
Update it if needed (e.g. updating Elixir’s version) and then update
The following domain names are currently in use by the deployed Elixir app:
These names are configured via a CNAME on CleverCloud.
The corresponding SSL certificates are auto-generated via Let's Encrypt and CleverCloud.
The project blog code and articles are hosted in the blog folder of the blog branch. A specific blog branch has been created with less restrictive merge rules, to allow publishing articles directly from the CMS without needing a github code review.
Technically, the blog is a hugo static website, enhanced with netlifyCMS that is automatically deployed using Netlify. NetlifyCMS allows github users who have write access to this repo to write and edit articles, without the need to use git nor github.
To write or edit an article, visit https://blog.transport.data.gouv.fr/admin/.
For developement purposes, you can run the blog locally. Install hugo, open a terminal, go the blog folder of the project and run
No usable OpenSSL found (during Erlang installation via ASDF)
MacOS come with a pre-installed version of LibreSSL which is a fork from OpenSSL. This could cause trouble since it's considered as a "no usable OpenSSL" by Erlang.
We can fix this error in 2 steps :
- Install OpenSSL 1.1 (via homebrew for example)
> brew install --prefix=openssl
- Force the use of the installed version when installing erlang by setting the --with-ssl option in the KERL_CONFIGURE_OPTIONS variable.
> export KERL_CONFIGURE_OPTIONS="--with-ssl=$(brew --prefix --installed firstname.lastname@example.org)" > asdf install erlang 24.0.4