Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 2.77 KB

README.md

File metadata and controls

96 lines (65 loc) · 2.77 KB
Raw

udata-front-kit

Verticales thématiques adossées à data.gouv.fr.

Configuration

Chaque verticale est configurée dans un fichier config.yaml stocké sous configs/$verticale.

La variable d'environnement VITE_SITE_ID permet de définir la configuration utilisée au lancement de l'application. Cette variable peut être définie dans le fichier .env ou ses dérivés.

Développement

Environnement recommandé

VSCode + Vue - Official + ESLint

Initialisation du projet

npm clean-install

# installe les pre-commit hooks Husky
npm run prepare

Commandes de référence

Compilation et hot-reload pour le développement

npm run dev

Compilation et minification pour la production

npm run build

Tests via Vitest

npm run test

Linting via ESLint

npm run lint

Typage via TSc

npm run hint

Code formatting with Prettier

npm run format

Librairies et plugins utilisés

Librairies

  • @datagouv/components // composants provenant de data.gouv.fr
  • @gouvminint/vue-dsfr // intégration vue de composants issus du DSFR
  • @gouvfr/dsfr // nécessaire pour les deux précédentes
  • @vueuse/core // collection d'utilitaires vue (useTitle)
    • @vueuse/integrations // intégration supplémentaires de vueuse (focustrap)
  • unplugin-auto-import - vite.config.mts // auto-import d'API vue (ref, computed…) et vue-dsfr (d'après ce tutoriel)
  • unplugin-vue-components - vite.config.mts // auto-import des composants custom et vue-dsfr (idem)
  • vee-validate // validation de formulaire
    • @vee-validate/rules // collection de règles de validation
  • @unhead/vue // SEO (en gros)

Formatage et validation du code

  • eslint - eslint.config.mjs
    • typescript-eslint
    • eslint-plugin-json
    • eslint-plugin-vue
  • prettier - .prettierrc.mjs
    • prettier-plugin-organize-imports // organise et/ou supprime les imports des fichiers

À chaque git commit, husky lance lint-staged qui formate les fichiers "staged" avec prettier.

Auteurs

  • data.gouv.fr, Direction interministérielle du numérique.
  • Ecolab, Commissariat général au développement durable, Ministère de la transition écologique.