search

CaenCamp / jobs-caen-camp

Gestion d'offres d'emploi pour les CaenCamp
https://www.caen.camp
GNU General Public License v3.0
9 stars 5 forks source link

chore: Add storybook #58

Closed Clebiez closed 4 years ago

Clebiez commented 4 years ago

Description

Pour pouvoir travailler ensemble de façon encore plus efficace et en se marchant le moins possible sur les pieds, le storybook est un endroit idéal.

Il va permettre de centraliser la charte graphique, les composants UI existants, et surtout de développer ces composants UI de sorte à ce qu'ils soient facilement réutilisable.

Pour éviter tout soucis de loader de composant, le storybook a été installé dans le workspace de l'app jobboard. Il n'est pas très copain avec les yarn workspaces, mais visiblement nous n'avons aujourd'hui pas besoin de documenter des composants ailleurs que dans notre job board.

Pour le lancer depuis la racine du projet :

yarn workspace cc-jobboard-front storybook

ou

make storybook

Le SB se lancera sur l'url http://localhost:6006

J'ai ajouté l'addon knobs & l'addon actions pour le moment.

Il existe d'autres addons qui font notamment du snapshot testing directement depuis le storybook mais c'est encore un peu tôt je pense pour s'embarrasser d'une solution comme cela

Clebiez commented 4 years ago

Hello @alexisjanvier Merci pour tes retours.

Effectivement j'avais un peu squizzé la partie docker avec Storybook.

C'est corrigé.

Par ailleurs j'ai update le contributing guide pour ajouter storybook avec un petit layus pour expliquer de façon très brève, ce que ça fait. N'hésitez pas à me faire vos retours surtout sur le niveau de vulgarisation à avoir pour ce type de documentation.