{"repo":"suitenumerique/cunningham","free":true,"listed":false,"github":"https://github.com/suitenumerique/cunningham","clone":"git clone https://github.com/suitenumerique/cunningham.git","description":"🎨 The Design System for OpenFUN and LaSuite","language":"TypeScript","stars":55,"topics":["css","design-system","design-systems","html","reactjs","atomic-design","figma","storybook","components-library","accessibility"],"license":"MIT","category":"ui-components","readme_excerpt":"Cunningham A design system and a components library. 📚&nbsp;&nbsp;Documentation • 🖌️&nbsp;&nbsp;Figma • 🕹️&nbsp;&nbsp;Demo - Atomic : We follow atomic design principles. - Modular and Reusable : Each component is designed to be self-contained and reusable across different projects, promoting consistency and saving development time. - Accessibility-focused : Our components prioritize accessibility standards, making them usable and inclusive for all users. - Design tokens based : We use design tokens to ensure consistency between design and code and allow high customization. - React based: at the moment we only support React, but we are open to other frameworks, feel free to contribute ! 🔎 Preview Here are some examples of real life usage of Cunningham components. See the documentation 📚 to learn more about customization, typography, spacings and available components! ⚡️ Getting started ➡️ First, install the library ➡️ Then, add this script to your package.json file ➡️ Then, in order to generate the css file, run It will generate a file named cunningham-tokens.css . ➡️ Then, add these lines at the top of your main stylesheet file: Please take a look at customization documentation for more informations about the cunningham command line tool and to customize your local theme. We're done! 🎉 To ensure everything works well, let's test rendering a component, such as the Button for example. Now please see the documentation 📚 to learn more about customization, typography, spaci","default_branch":null,"files":null,"tree":[],"storefront":"/r/suitenumerique","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/suitenumerique/cunningham/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}