Mozaic-React (community)

This is a community project containing React components that implements the ADEO Design system guidelines.

## 🎨 Getting started **ADEO Design system** is a global and collaborative design system that facilitates the designer and developer experience, enabling them to create universal interfaces perfectly aligned with the business strategy of [Adeo](https://www.adeo.com/). Learn more about the vision and guidelines by visiting the [main documentation website](https://mozaic.adeo.cloud/). ## 📦 Install All the available components are showcased in our [Storybook](https://musical-happiness-538039b4.pages.github.io/?path=/docs/getting-started--docs). To install `mozaic-react` in your project, you will need to run the following command using `npm`: ```shell $ npm install @mozaic-ds/react --save ``` Or with **Yarn**: ```shell $ yarn add @mozaic-ds/react ``` ## 📰 Changelog Releases are managed with **GitHub Releases**, including the changelog for each one.
Access to the [Changelog](/CHANGELOG.md) to find out about the detailed changes to each release. ## 📣 Stay in touch - Join the [#mozaic-react](https://app.slack.com/client/T4R6RCZFA/CTKEF69GV) channel on **Slack** ## 🐞 Bugs and feature requests Have a bug or a feature request?
Please [open an issue](https://github.com/adeo/mozaic-styles/issues/new/choose) and use the template associated with your request. However, if you are able to contribute and fix bugs, build new features, or help to improve the project documentation, feel free to do it! _(more information below)_ ## ✍️ Contributing Setup the project to start contributing. ``` // Clone mozaic-react repo $ git clone git@github.com:adeo/mozaic-react.git // Go to the cloned directory $ cd mozaic-react // Checkout the branch you are working on $ git checkout // Install dependencies $ npm install // Launch Storybook npm run start ``` Congratulations, `Storybook` is running on [http://localhost:6006/](http://localhost:6006/). :rocket: We're always looking for contributors to help us fix bugs, build features, or help us improve the documentation. If you're intersted check out our [Code of Conduct](https://github.com/adeo/mozaic-react/wiki/Code-of-conduct) and [Contribution Guide](https://github.com/adeo/mozaic-react/blob/master/CONTRIBUTING.md). ## 🧑‍💻 Contributors **Maintainers** - **[Patryk Mazur](https://github.com/sudo-at-night)** - **[Michał Kowalik](https://github.com/mkowalik-lr)** - **[Rafał Kulpa](https://github.com/rkulpaLM2)** - **[Adam Jacewicz](https://github.com/ajacewiczlm)** Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Eugene Abrosimov} 💻 📖 💡 🤔 🚇 🚧 🧑‍🏫 📆 👀 📓	_sstolbov 💻 🚇 🚧 ⚠️ 📓 👀	_{Ilia Antonov} 👀 🤔 🚧 🧑‍🏫 📆	_{Nikolai Kuznetsov} 👀 🤔 🚧 🧑‍🏫 📆 💻 ⚠️	_{Denis Timashev} 👀 💻 📖	_narapov 🤔 👀	_{K. Khabalkin} 👀
_{Edele Gizatullin} 👀	_{Vasenina Nastya} 👀 💻 📖	_Jupoulet 💻 📖 👀 🤔 🧑‍🏫	_{Samuel Poudroux} 💻 📖 👀	_AlexFe96 💻 📖	_{Gabin Bloquet} 💻 📖	_{Julien Hery} 🐛 💻 💡 🤔
_{Dmitrii Maletskii} 💻 📖 👀	_{Andrew Zhukov} 💻 📖 👀	_{Gabin Darras} 👀	_Artyom 💻 📖	_{Jakub Czarnowski} 💻	_{Rafael Fachinelli} 📖 🐛 💻	_{Ewen SELLITTO} 🐛 💻 📖
_C-Melvin 🐛 💻	_{Patryk Mazur} 🚧 💻	_{Michał Kowalik} 🚧 💻 👀 🐛	_rkulpaLM2 🚧 👀	_ajacewiczlm 🚧 👀 💻 🐛
Add your contributions

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## 📄 Licensing This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.