Skip to content

datagouv/support.data.gouv.fr

Repository files navigation

💁‍♂️ [data.gouv.fr](https://data.gouv.fr) support application 💁‍♂️

- [Installation](#installation) - [Development](#development) - [Configuration](#configuration) - [Tests](#tests) - [Architecture decision records](#architecture-decision-records) - [Inspirations](#inspirations)

Installation

  • cp .env.dist .env
  • Adjust the .env file with development settings
  • npm install
  • You have to use node v14 (nvm install 14 && npm use 14)

Development

  • npm run start:dev

Configuration

In order to change the displayed question tree, one might change the config/question-tree.yaml file.

This file is written in YAML.

It starts with a top-level question, consisting in a title, and choices on which the user can click.

Each item of the choices attribute consists in a label displayed on the webpage, a link which can be a new question or an answer, and an id used to identify the choice.

The id must be URL-friendly, it consists of one or many lowecase words separated by -.

A new question follows the same structure as the top-level question.

An answer can be of three types:

  • a path attribute, which must be a relative path to a markdown file containing the content to display
  • a content attribute, which is the raw html displayed content
  • a form attribute, which represents a ticket submission form, with the following properties:
    • title: the contact form title, displayed at the top
    • recipient: the target email address handled by Etalab's Zammad

Tests

  • npm run test

Architecture decision records

  1. Record architecture decisions
  2. Domain-driven design
  3. Server-side rendering

Inspirations

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published