# TQ.Components ## Table des Matières 1. [Introduction](#introduction) ## Introduction Pour les besoins de Télé-Québec une librairie de composante a été créée. Cette librairie est composée de composantes réutilisables et styliser. Les composantes sont créées en utilisant les technologies suivantes: - [Lit](https://lit.dev/) - [Shoelace](https://shoelace.style/) ## Guide de demarrage rapide Installer les dépendances du projet et les dépendances système pour Playwright. - `pnpm run setup` Creation de components - `src/components/mycomponent` - `src/components/mycomponent/mycomponent.component.ts` - `src/components/mycomponent/mycomponent.styles.ts` - `src/components/mycomponent/mycomponent.test.ts` - `src/components/mycomponent/mycomponent.ts` Utiliser `index.html` pour developer les composants ```html ``` Lancer le serveur de développement - `pnpm run dev` ## Contribution - `next` - Branche de la prochaine iteration - `feat/mycomponent` - Branche de feature Créer une branche de feature à partir de `next` et faire une pull request vers `next`. Le CI va tester la branche automatiquement. Pour faire un release, executer le CD et choisir le type de release. Les types de release sont: - `patch` - Pour les correctifs de bug - `minor` - Pour les nouvelles fonctionnalités - `major` - Pour les changements majeurs ## TODO - Changelog - DDD: Documentation Driven Development - Utiliser un générateur de site statique (par exemple : 11ty) pour développer les composants dans la documentation. - Script cli pour la creation de la structure de composants ## Credits - [Lit](https://lit.dev/) - [Shoelace](https://shoelace.style/)