Prototypez et développez vos projets plus rapidement grâce à Neu UI, la librairie neumorphique de composants React.
- ❓ À propos
- 🚀 Mise en route
- 📝 Documentation
- 👏 Contribuer
- ⚖️ Licence
Le projet Neu UI a débuté comme une simple expérimentation de design de composants UI et de développement utilisant le style neumorphique.
Ce style fut à l'origine conceptualisé par Alexander Plyuto vers la fin 2019 et le « neumorphisme », un mix entre le « skeumorphisme » et le « material design », fut inventé peu après par Michal Malewicz.
Pour plus d'information sur ce style, vous pouvez lire le guide d'Alexander Plyuto ici.
Les composants initiaux ont maintenant été convertis et étendus pour inclure un ensemble de formulaires contrôlés et de composants cartes dans une librairie React. Neu UI se base donc sur React et utilise Storybook comme outil pour visualiser les composants, ainsi que Styles Components pour, comme son nom l'indique, styliser les composants.
Nous recherchons des personnes intéressées à contribuer. Pour plus d'information, rendez-vous dans la partie « Contribuer » ci-dessous.
Installation avec npm.
npm i ui-neu
Installation avec yarn.
yarn add ui-neu
Importer un composant.
import { Card } from 'ui-neu'
La documentation inclue des informations sur les props, de l'aide pour commencer à contribuer et un guide de contribution.
Accéder à la documentation de Neu UI
Si vous souhaitez contribuer, nous acceptons avec plaisir toute aide, que ce soit de la documentation, de la correction de bugs ou même du développement d'améliorations.
- Les « pull requests » et les ⭐ étoiles sont les bienvenues !
- Lisez le guide sur commencer à contribuer pour savoir par où commencer
- Si vous cherchez des informations plus détaillées sur comment contribuer, alors penchez-vous sur le guide de contribution
Vous cherchez une « issue » pour une première contribution au projet ?
- Filtrez sur les labels good first issue
- Par encore prêt à faire une contribution au code ? Alors gardez un œil sur les labels documentation
- Besoin d'aide ? Contactez-moi, Dan sur Twitter
Ce projet est sous licence MIT.