Skip to content

Repository files navigation

DossierFacile Front-end

DossierFacile.fr a été créé par le Ministère de la Transition écologique pour aider à la réalisation de dossiers de location.

Ce projet correspond aux sites DossierFacile et FiligraneFacile Nous utilisons pnpm pour compiler le projet en monorepo, nous utilisons le framework Vue.

Ce projet est composé de 4 apps : www pour la page d'accueil, blog etc. tenantv3 pour la partie locataire, owner pour la partie propriétaire et watermark pour le site Filigrane.

Des composants partagés entre les applis sont également disponible dans le répertoire df-shared-next.

Pour finir, des tests end to end sont présents dans le répertoire e2e-tests

Pré-requis

Vous aurez besoin de node v22 et pnpm pour construire le projet.

Installation

Cloner ce repository et exécutez pnpm install pour installer les dépendences.

Configuration

Dans chaque dossier www, tenantv3, owner et watermark, copier le fichier .env.example dans .env.local et modifiez les valeurs adéquates.

robots.txt behaviour

The build injects a robots.txt file based on VITE_ENVIRONMENT:

  • prod keeps public/robots.txt (allowing the app to be indexed).
  • any other value replaces it with a disallow-all robots file at build time via df-shared-next/src/plugin/robots.

Backend

Assurez-vous d'avoir installé et configuré correctement la partie backend afin que la partie front puisse fonctionner.

Lancement

Depuis la racine du monorepo :

Commande Projet lancé
pnpm dev Site vitrine + applications locataire et propriétaire
pnpm dev:www Site vitrine
pnpm dev:tenant Application locataire et site vitrine
pnpm dev:owner Application propriétaire et site vitrine
pnpm dev:watermark FiligraneFacile
pnpm dev:storybook Storybook
pnpm dev:e2e Interface Cypress pour les tests E2E locaux

Les quatre applications peuvent également être lancées depuis leur dossier avec pnpm dev. Le package df-shared-next est une bibliothèque consommée par les applications et ne possède pas de serveur à lancer.

Lancer les tests end-to-end

Démarrez les applications locales, ainsi que les API backend correspondantes, puis lancez pnpm dev:e2e pour ouvrir Cypress ou pnpm --filter e2e-tests test pour exécuter les tests sans interface.

Contexte pour les agents de code (AGENTS.md)

L'équipe a retenu une approche agnostique de l'agent IA utilisé : les fichiers AGENTS.md, conformes au standard ouvert AGENTS.md. On y décrit la stack, les packages et les sujets transverses (i18n, accessibilité, tests). La plupart des assistants de code IA savent le lire nativement, sans configuration supplémentaire.

Cas particuliers

Outil Particularité À faire dans ce repo
Claude Code (Anthropic) Format natif : CLAUDE.md Créer un lien symbolique vers le même contenu : ln -s AGENTS.md CLAUDE.md (à la racine). Autre option : importer le fichier depuis CLAUDE.md avec @AGENTS.md.
Gemini CLI (Google) Format natif : GEMINI.md Pointer vers AGENTS.md dans .gemini/settings.json : {"contextFileName": "AGENTS.md"}.

Pour ne pas avoir à maintenir plusieurs versions en parallèle, AGENTS.md reste l'unique référence : CLAUDE.md et GEMINI.md ne sont ajoutés que par lien symbolique ou import, selon l'outil utilisé dans l'équipe.

Contributions

Les pull requests sont possibles. Pour des changements majeurs, veuillez d'abord contacter l'équipe sur l'adresse contact@dossierfacile.fr.

License

MIT

⚠️ IMPORTANT : Limites d'utilisation

Bien que ce code soit distribué sous licence open source MIT, certains éléments contenus dans ce repository sont protégés et leur réutilisation est strictement interdite :

Marque DossierFacile

Ce repository utilise le nom et le logo de DossierFacile, qui constituent une marque déposée de l'État français. Toute utilisation de cette marque en dehors du contexte officiel est interdite.

Système de Design de l'État Français (DSFR)

Ce repository met en oeuvre le Système de Design de l'État Français (DSFR). Il est formellement interdit à tout autre acteur d'utiliser le DSFR pour des sites web ou des applications. Le DSFR représente l'identité numérique de l'État français.

Sanctions légales

En cas d'usage non autorisé, vous vous exposez à des poursuites légales, notamment sur la base des articles suivants :

Recommandation : Si vous souhaitez réutiliser ce code, supprimez ou remplacez tous les éléments liés à la marque DossierFacile et au DSFR avant déploiement.

Releases

Packages

Used by

Contributors

Languages