n3n / transport-site

Rendre disponible, valoriser et améliorer les données transports

Transport

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.

Glossary

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.

Installation

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.

Manual installation

• 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 mix deps.get
• 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:

• asdf install

Postgresql

You also need an up to date postgresql with postgis installed. Version 12+ is recommended.

For Mac users, you can use https://postgresapp.com/.

Dependencies

Download depencies using mix deps.get.

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 mix ecto.create.

Alternatively, you can create it manually. With the permission to create a database (on Debian based system, you need to be logged as postgres), type createdb transport_repo.

Applying the migrations

To have an up to date database schema run mix ecto.migrate.

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: ./restore_db.sh <path_to_the_backup>

Usage

Run the server with mix phx.server and you can visit 127.0.0.1:5000 on your browser.

Development

Testing

Running the tests

Run the tests with mix test

You can also:

• Run the "external" tests with mix test --only external
• Run everything with RUN_ALL=1 mix test

The application is an umbrella app. It means that it is split into several sub-projects (that you can see under /apps).

To run tests for a specific app, for example the transport or 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
RUN_ALL=1 mix coveralls --umbrella
# Same with a HTML report
RUN_ALL=1 mix coveralls.html --umbrella

# Display coverage for each umbrella component, rather
mix coveralls

The coverage is written on screen by default, or in the cover subfolders for HTML output.

Running in --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. apps/db/cover).

Linting

• Run the elixir linter with mix credo --strict
• Run the javascript linter with mix npm "run linter:ecma"
• Run the sass linter with mix npm "run linter:sass"

Misc Elixir command

Translations

To extract all translations from the source, you can run mix gettext.extract --merge (and then edit the modified .po files).

DB migrations

To generate a new migration file: cd apps/db && mix ecto.gen.migration <name of the migration> && cd ..

The generated ecto migration file will be apps/db/priv/repo/migrations/<timestamp>_<name of the migration>.exs

To apply all migrations on you database: mix ecto.migrate

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

Docker installation

Development

If you don't plan to work a lot on this project, the docker installation is way easier.

You need a .env file with the same variables that you have in .envrc.example (but you'll need to remove export at the beginning of each line. (No need to setup the variable PG_URL, it is defined in the docker-compose.yml)

Then you only need to run: docker-compose up

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

Production

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 .circleci/config.yml.

Blog

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 hugo serve.