0.7.2 • Published 4 months ago

@typo13/ty-ui v0.7.2

Weekly downloads
-
License
-
Repository
-
Last release
4 months ago

🌟 TY-UI

pipeline status GitLab Issues License: MIT npm version npm downloads GitLab Last Commit

📜 Introduction

Ce projet "Ty-ui" a pour but de créerune librairie répondant aux critères d'accessibilité. Dans un second temps, j'aimerais que le design soit personnalisable.

🛠️ Build With

React Storybook

📦 Installation

Pour installer Ty-ui, vous pouvez utiliser npm ou yarn :

npm install @typo13/ty-ui

🚀 Utilisation

Pour une documentation complète et des exemples interactifs, consultez notre Storybook.

🐛 Issues

Pour signaler des bugs ou suggérer des améliorations, veuillez utiliser les issues GitLab.

🤝 Contribution

Les contributions sont les bienvenues !

Avant de contribuer, créé une issue pour discuter du point qui vous intéresse.

Une fois l'issue validé par nos soins, si vous souhaitez contribuer à ty-ui, veuillez suivre ces étapes :

  • Forker le projet.
  • Créer une branche pour votre fonctionnalité (git checkout -b feature/NouvelleFonctionnalite).
  • Committer vos modifications (git commit -m 'Ajouter une nouvelle fonctionnalité').
  • Pusher la branche (git push origin feature/NouvelleFonctionnalite).
  • Ouvrir une Merge Request.

🛠️ Installation en Local

Pour installer le projet en local et faire des modifications, suivez ces étapes :

Clonez le dépôt :

git clone https://gitlab.com/typo-dev/applications/ty-ui/applications/ty-ui.git

Accédez au répertoire du projet :

cd ty-ui

Installez les dépendances :

npm install

Lancez le storybook :

npm storybook

📜 Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

Merci d'utiliser TY-UI ! 🚀