template

Template minimal de la Fabrique des ministères sociaux qui intègre nos recommandations tech. Une présentation complète est visible ici.

⚠️ Le Système de Design de l'État s'adresse uniquement aux développeurs et aux concepteurs, qu'ils soient agents publics ou prestataires pour des sites Internet de l'État (Ministères, Administrations centrales, Préfectures, Ambassades, etc.). cf conditions d'utilisation.

Description

• 🇫🇷 Basé sur codegouv/react-dsfr
• ⚖️ Pages de "conformité" (CGU, RGPD, stats..)
• 📦 Testing, lint, CI & release automatisés
• 🔒 Image docker rootless, header CSP
• 🔑 prévention de fuite de secrets avec talisman
• 📊 Intégration de sentry & matomo
• ⚡️ Basé sur Next et TypeScript

Dans le détail

D'un point de vue fonctionnel

• Page principale
• Politique de confidentialité
• Mentions légales
• Conditions générales d'utilisation
• Statistiques d'utilisation (fonctionnant avec matomo)
• Déclaration d'accessibilité
• Healthz
• Page 404

En plus dans la branche hasura :

• Page d'authentification
• Page d'inscription
• Page profil
• Interactions avec la base de données

D'un point de vue technique

• storybook permettant de réaliser des stories pour les composants

• @testing-library pour tester de manière unitaire les composants

• jest pour tester de manière unitaire le code

• cypress pour tester en e2e le frontend

• talisman qui permet de prévenir la publication de secrets dans votre code

• un Dockerfile rootless de production basé sur nginx

• des Content Security Policy et headers de sécurité de base

• Côté Next.js:

  • intégration de @codegouvfr/react-dsfr pour le design système de l'état
  • intégration de sentry pour gérer les erreurs
  • intégration de matomo pour les statistiques d'utilisation

En plus dans la branche hasura :

• keycloak qui est un serveur d'authentification (exclusive à main)
• next-auth qui est un wrapper pour gérer l'authentification au sein de l'application (exclusive à main)
• hasura qui permet d'exposer une API GraphQL sur votre Postgres et de gérer les authorisations (RBAC)

Lancer le code

Après avoir cloné le projet :

Développement

⚠️ Avant de lancer le projet, vous devez installer gomplate

yarn # to install dependencies
yarn dev # to run in dev mode

Gestion des environnements

Les variables issues des docker build-args, sont à utiliser dans next.config.js, pour les autres, il faut les définir dans les différents .env.*.

Le fichier .env.staging est utilisé pour les environnements de review et de pré-production.

Le fichier .env.development est utilisé pour l'environnement de développement.

⚠️ Les variables d'environnement sont publiques (utilisées durant le build), ne commitez donc pas de variables privées dans ces fichiers.

Variables d'env

cf .env.development

en production, les secrets sont chiffrés dans GIT avec sealed-secrets.

Branche Hasura

Cette branche propose des composants backends de référence.

---

graph LR
Browser{Browser}-->|JWT|Frontend[Frontend/API Next.js]
Browser-->KeyCloak
Frontend-->|JWT|Hasura
KeyCloak-->PG1[PostgreSQL]
KeyCloak-->|JWT|Browser
Hasura-->|RBAC|PG2[PostgreSQL]
KeyCloak-->FranceConnect

Loading

---

Lancer les serveurs Postgres, hasura et keycloak avec docker-compose up.

Hasura

Lancer les seeds :

yarn hasura seed apply --file books.sql --project ./hasura --database-name default --endpoint http://127.0.0.1:8082 --admin-secret myadminsecretkey

Mettre à jour les metadatas et migrations :

Lancer la console avec yarn hasura console --project ./hasura --endpoint http://127.0.0.1:8082 --admin-secret myadminsecretkey. Les modifs faites dans l'UI seront reportées dans les dossiers hasura/metadata et hasura/migrations

Cf migrations documentation

KeyCloak

Le template intègre Next-auth et KeyCloak 20 qui assure tous les workflows d'authentification.

Le realm par défaut est dans .kontinuous/files/realm-export.json. Pour générer realm utilisable par docker-compose à partir de celui-ci, utilisez yarn keycloak.

Le thème keycloak est basé sur le design-système de l'état, cf keycloak de sill-web.

FranceConnect

Cf https://partenaires.franceconnect.gouv.fr/fcp/fournisseur-service

Dans les URLs de callback définies sur le compte FranceConnect, utiliser https://[votre-hostname]/realms/app-realm/broker/franceconnect-particulier/endpoint et https://[votre-hostname]/realms/app-realm/broker/franceconnect-particulier/endpoint/logout_response.

Déploiement sur kubernetes

Template utilise kontinuous pour définir et déployer ses ressources kubernetes.

Lancer npx kontinuous build --env dev -o pour obtenir les manifests de votre environment (dev, preprod ou prod).

La version dev est déployée sur OVH.

Liens

• https://template.fabrique.social.gouv.fr/ : Version en production du projet
• https://socialgouv.github.io/template/ : Storybook liés à la branche principale du projet
• https://github.com/socialgouv/keycloak-dsfr : Thème keycloak-DSFR
• https://socialgouv.github.io/support : Documentation technique SocialGouv