Skip to content

Commit 068bf8a

Browse files
committed
Update the french version of the readme an other minor fixes
1 parent df55657 commit 068bf8a

File tree

2 files changed

+69
-49
lines changed

2 files changed

+69
-49
lines changed

README.fr.md

Lines changed: 68 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -26,45 +26,42 @@
2626
<a href="https://stackblitz.com/edit/nextjs-j2wba3?file=pages/index.tsx">essai immédiat</a>
2727
</p>
2828

29-
> ATTENTION: Ce design système a uniquement vocation à être utilisé pour des sites officiels de l'état.
30-
> Son but est de rendre la parole de l'état clairement identifiable. [Consulter le CGU](https://www.systeme-de-design.gouv.fr/utilisation-et-organisation/perimetre-d-application)
29+
> AVERTISSEMENT : Ce système de conception est uniquement destiné à être utilisé pour les sites web officiels des services publics français.
30+
> Son objectif principal est de faciliter l'identification des sites gouvernementaux par les citoyens. [Voir les conditions](https://www.systeme-de-design.gouv.fr/utilisation-et-organisation/perimetre-d-application).
3131
32-
> 🗣️ L'enregistrement de l'atelier de présentation de la librairie est disponible [ici](https://bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/22298bc9d93b53540248207bc3f9e31260f3b4f1-1670578779094).
33-
34-
Ce module NPM est une surcouche de compatibilité React pour [@gouvfr/dsfr](https://www.npmjs.com/package/@gouvfr/dsfr), l'implémentation officielle de référence du
35-
DSFR en pur JavaScript/CSS.
32+
Ce module est une boîte à outils avancée qui tire parti de [@gouvfr/dsfr](https://github.com/GouvernementFR/dsfr), l'implémentation en JS/CSS vanilla du DSFR.
3633

3734
<a href="https://youtu.be/5q88JgXUAY4">
3835
<img width="1712" alt="image" src="https://user-images.githubusercontent.com/6702424/224423044-c1823249-eab6-4844-af43-d059c01416af.png">
3936
</a>
4037

41-
> Bien que cette bibliothèque soit écrite en TypeScript, l'utilisation de TypeScript dans votre application est facultative (mais recommandée car elle présente des avantages exceptionnels pour vous et votre base de code).
42-
43-
- [x] une interface de programmation strictement typée et bien documentée.
44-
- [x] Garantie d'être toujours à jour avec les [dernières évolutions du DSFR](https://www.systeme-de-design.gouv.fr/).
45-
Une grande partie du code et du typage est généré procéduralement à partir de la feuille de style de référence: [`@gouvfr/dsfr`](https://www.npmjs.com/package/@gouvfr/dsfr)`/dist/dsfr.css`.
46-
- [x] exactement le même aspect et ressenti qu'avec [@gouvfr/dsfr](https://www.npmjs.com/package/@gouvfr/dsfr), il s'agit d'une couche de compatibilité et non pas d'une implémentation alternative.
47-
- [x] pas de [flash d'écran blanc lors du basculement automatique du thème clair vers le thème sombre](https://github.com/codegouvfr/@codegouvfr/react-dsfr/issues/2#issuecomment-1257263480).
48-
- [x] la plupart des composants peuvent être rendus directement sur le serveur (voir [RSC](https://reactjs.org/blog/2020/12/21/data-fetching-with-react-server-components.html)). Les autres sont étiquetés `"use client";`.
49-
- [x] [Intégration clef en main pour les différents frameworks de développement: vite, Next.js, y compris la version beta de Next 13 (configuration AppDir) et Create React App](https://react-dsfr.codegouv.studio/) si votre
50-
framework n'est pas supporté, il suffit de demander notre **il manque un mot là** , nous avons pour but de couvrir tous les cas d'usage effectifs.
51-
- [x] (Presque) tout [les composants de référence](https://www.systeme-de-design.gouv.fr/elements-d-interface) sont [implémenté](https://components.react-dsfr.codegouv.studio/).
52-
- [x] seulement le code des composants que vous utilisez effectivement sera inclus dans votre projet final.
53-
- [x] Intégration facultative avec [MUI](https://mui.com/). Si vous utilisez des composants MUI ils seront automatiquement adaptés pour ressembler à des composants DSFR.
54-
Voir la [documentation](https://react-dsfr.codegouv.studio/mui-integration).
55-
- [x] permet de développer à l'aide d'outil de CSS-in-JS comme [Styled component](https://styled-components.com/), [Emotion](https://emotion.sh/docs/introduction) ou [TSS](https://www.tss-react.dev/).
56-
- [x] prévoit un système de traduction pour les textes présents dans les composants (i18n).
57-
- [x] [s'intègre avec les librairies de routing](https://react-dsfr.codegouv.studio/routing) comme [React Router](https://reactrouter.com/en/main), [TanStack Router](https://tanstack.com/router/v1) ou encore [Type route](https://type-route.zilch.dev/).
58-
59-
> 💡 Besoin de pages de connexion au DSFR? Allez voir [keycloak-theme-dsfr](https://github.com/codegouvfr/keycloak-theme-dsfr).
38+
> Bien que ce module soit écrit en TypeScript, l'utilisation de TypeScript dans votre application est optionnelle (mais recommandée car elle apporte des avantages exceptionnels à la fois pour vous et votre base de code).
39+
40+
- [x] API entièrement TypeSafe, bien documentée.
41+
- [x] Toujours à jour avec les dernières évolutions du DSFR.
42+
Code et Types générés à partir de [`@gouvfr/dsfr`](https://www.npmjs.com/package/@gouvfr/dsfr)`/dist/dsfr.css`.
43+
- [x] Exactement le même aspect et ressenti qu'avec [@gouvfr/dsfr](https://www.npmjs.com/package/@gouvfr/dsfr).
44+
- [x] Pas de [flash blanc lors du rechargement dans la configuration SSR](https://github.com/codegouvfr/@codegouvfr/react-dsfr/issues/2#issuecomment-1257263480).
45+
- [x] La plupart des composants sont prêts pour les composants serveur. Les autres sont étiquetés avec `"use client";`
46+
- [x] [Intégration parfaite avec tous les principaux frameworks React : Next.js (PagesDir et AppDir), Create React App, Vue](https://react-dsfr.codegouv.studio/).
47+
- [x] (Presque) Tous [les composants](https://www.systeme-de-design.gouv.fr/elements-d-interface) sont [implémentés](https://components.react-dsfr.codegouv.studio/)
48+
- [x] Trois distributions modulables, choisissez les composants que vous importez. (Ce n'est pas tout dans un gros bundle .js)
49+
- [x] Intégration optionnelle avec [MUI](https://mui.com/). Si vous utilisez des composants MUI, ils seront
50+
automatiquement adaptés pour ressembler aux [composants DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface). Voir [documentation](https://react-dsfr.codegouv.studio/mui-integration).
51+
- [x] Activez CSS in JS en fournissant un hook `useColors()` qui expose les bonnes options de couleurs et décisions
52+
pour le schéma de couleurs actuellement activé.
53+
- [x] i18n en option, les textes intégrés peuvent être affichés en plusieurs langues et l'utilisateur peut fournir des traductions supplémentaires.
54+
- [x] [Support des bibliothèques de routage](https://react-dsfr.codegouv.studio/routing) comme react-router.
55+
56+
> 💡 Besoin de pages de connexion et d'inscription prêtes à l'emploi et conformes au DSFR ? Consultez [keycloak-theme-dsfr](https://github.com/codegouvfr/keycloak-theme-dsfr).
6057
6158
<p align="center">
62-
<a href="https://react-dsfr.codegouv.studio/">🚀 Commencer maintenant 🚀 </a>
59+
<a href="https://react-dsfr.codegouv.studio/">🚀 Commencez ici 🚀 </a>
6360
</p>
6461

6562
# Gouvernance
6663

67-
Ce module est un produit du pôle logiciel libre et open source d'[Etalab](https://code.gouv.fr/en/mission/).
64+
Ce module est un produit du pôle Logiciel libre et open source d'[Etalab](https://code.gouv.fr/en/mission/).
6865

6966
Ce projet est co-maintenu par des fonctionnaires de diverses administrations françaises :
7067

@@ -74,33 +71,61 @@ Ce projet est co-maintenu par des fonctionnaires de diverses administrations fra
7471

7572
Il est également co-maintenu par [Joseph Garrone](https://github.com/garronej), l'auteur original.
7673

77-
## Development
74+
## Développement
7875

7976
```bash
8077
git clone https://github.com/codegouvfr/react-dsfr
8178
cd react-dsfr
8279
yarn
8380

84-
# Démarrer Storybook
81+
# Démarrer storybook
8582
yarn storybook
8683

8784
# Démarrer les applications de test
88-
yarn start-cra
89-
yarn start-vite
90-
yarn start-next-pagesdir
91-
yarn start-next-appdir
85+
yarn start-cra # Pour tester dans une configuration Create React App
86+
yarn start-vite # Pour tester dans une configuration Vite
87+
yarn start-next-pagesdir # Pour tester dans une configuration Next.js 13 PagesDir (la configuration par défaut)
88+
yarn start-next-appdir # Pour tester dans une configuration Next.js 13 AppDir
9289

93-
# Executer tout les tests unitaires (test/runtime):
90+
# Exécuter tous les tests unitaires (test/runtime):
9491
yarn test
95-
# Executer, par exemple, uniquement le test test/runtime/cssVariable.test.ts
92+
# Exécuter uniquement test/runtime/cssVariable.test.ts (par exemple)
9693
npx vitest -t "Resolution of CSS variables"
9794
```
9895

99-
### Vous cherchez comment contribuer?
100-
101-
Tout d'abord, merci ! Voici [le guide de contribution](https://github.com/codegouvfr/react-dsfr/blob/main/CONTRIBUTING.md).
102-
103-
### Comment publier une nouvelle version sur NPM
104-
105-
Ce dépôt a été mis en place avec [garronej/ts-ci](https://github.com/garronej/ts-ci).
106-
Vous pouvez vous référer à la documentation de TS-CI pour comprendre le cycle de vie de ce projet.
96+
### Vous voulez contribuer ?
97+
98+
Merci ! Voir [le guide de contribution](https://github.com/codegouvfr/react-dsfr/blob/main/CONTRIBUTING.md).
99+
100+
### Comment publier une nouvelle version sur NPM, comment sortir une version bêta
101+
102+
Ce dépôt a été initialisé à partir de [garronej/ts-ci](https://github.com/garronej/ts-ci), consultez la
103+
documentation de ce starter pour comprendre le cycle de vie de ce dépôt.
104+
105+
## Cas d'utilisation
106+
107+
Quelques projets qui utilisent `@codegouvfr/react-dsfr`.
108+
109+
- [https://code.gouv.fr/sill](https://sill-preprod.lab.sspcloud.fr/)
110+
- https://cartes.gouv.fr
111+
- https://immersion-facile.beta.gouv.fr/
112+
- https://egapro.travail.gouv.fr/
113+
- https://maisondelautisme.gouv.fr/
114+
- https://refugies.info/fr
115+
- https://www.mediateur-public.fr/
116+
- https://signal.conso.gouv.fr/
117+
- https://observatoire.numerique.gouv.fr/
118+
- https://github.com/BaseAdresseNationale/adresse.data.gouv.fr
119+
- https://github.com/DISIC/observatoire.numerique.gouv.fr
120+
- https://github.com/DISIC/monfranceconnect
121+
- https://github.com/InseeFr/Lunatic-DSFR
122+
- https://github.com/EIG6-Geocommuns/lidarviz-front
123+
- https://github.com/EIG6-Geocommuns/geocommuns-core
124+
- https://github.com/SocialGouv/bpco-site
125+
- https://github.com/EIG6-ArtificIA/predictia_front
126+
- https://github.com/BaseAdresseNationale/bal-admin
127+
- https://github.com/etalab/sill-web
128+
- https://github.com/inclusion-numerique/mediature
129+
- https://territoiresentransitions.fr (peut-être)
130+
- https://potentiel.beta.gouv.fr
131+
- https://diagoriente.beta.gouv.fr

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,6 @@ yarn start-next-appdir # For testing in a Next.js 13 AppDir setup
9393
yarn test
9494
# Run only test/runtime/cssVariable.test.ts (for example)
9595
npx vitest -t "Resolution of CSS variables"
96-
97-
# Debugging while unit testing
9896
```
9997

10098
### Want to contribute?
@@ -110,7 +108,7 @@ documentation of this starter for understanding the lifecycle of this repo.
110108

111109
A few projects that use `@codegouvfr/react-dsfr`.
112110

113-
- https://code.gouv.fr/sill
111+
- [https://code.gouv.fr/sill](https://sill-preprod.lab.sspcloud.fr/)
114112
- https://cartes.gouv.fr
115113
- https://immersion-facile.beta.gouv.fr/
116114
- https://egapro.travail.gouv.fr/
@@ -133,6 +131,3 @@ A few projects that use `@codegouvfr/react-dsfr`.
133131
- https://territoiresentransitions.fr (maybe)
134132
- https://potentiel.beta.gouv.fr
135133
- https://diagoriente.beta.gouv.fr
136-
137-
Keep in mind that the project has been released recently so it's only natural
138-
that there is only a few projects in production using it.

0 commit comments

Comments
 (0)