UNPKG

ui-neu

Version:

Neu UI, a responsive React component library.

86 lines (55 loc) 3.46 kB
# Neu UI ![github issues shield](https://img.shields.io/github/issues/daniel-norris/neumorphic_design) ![releases](https://img.shields.io/github/v/release/daniel-norris/neu_ui?include_prereleases) ![github licence](https://img.shields.io/github/license/daniel-norris/neu_ui) ![github commit activity shield](https://img.shields.io/github/commit-activity/m/daniel-norris/neumorphic_design) ![twitter](https://img.shields.io/twitter/follow/danielpnorris) ![repository example](../../src/demo.gif) Twórz prototypy i projekty szybciej używając Neu UI - neumorficznej biblioteki komponentów react. ## Tłumaczenia - [Vietnamese](./translations/vietnamese/readme.md) - [Brazilian Portuguese](./translations/portuguese/README.md) - [French](./translations/french/readme.md) - [Malay](./translations/malay/README.md) - [Italian](./translations/italian/README.md) - [Polish](./translations/polish/README.md) ## Znajdziesz tutaj - ❓ O projekcie - 🚀 Pierwsze kroki - 📝 Dokumentacja - 👏 Kontrybucja - ⚖️ Licencja ## O projekcie Neu UI zaczeło swoję życie jako mały poboczny projekt eksplorujący projektowanie komponentów UI oraz dewelopment przy użyciu neumorficznego dizajnu. Styl został pierwotnie opracowny przez [Alexander Plyuto](https://dribbble.com/alexplyuto) pod koniec 2019 a "neumorfizm" będący mieszanką skeumorfizmu oraz material dizajnu, wymyślił wkrótce potem Michał Malewicz. Po więcej informacji warto zajrzeć do przewodnika Alexandra Plyuto [tutaj](https://www.figma.com/file/J1uPSOY5k577mDpSfGFven/Neomorphism-Guide-2.0-%7C-Original?node-id=26580%3A1425). Początkowe komponenty zostały przekonwertowane i rozszerzone aby uwzględnić cały zestaw kontrolowanych komponentów takich jak formularze i karty w bibliotece React. Używamy reacta, Storybook jako narzędzie do wizualizacji komponentów oraz Styled components do stylizacji komponentów. Szukamy osób chętnych do współtworzenia projektu, po więcej informacji sprawdź sekcję "współpraca" poniżej. ## Zacznijmy od początku ### Instalacja Instalacja za pomocą `npm`. ``` npm i ui-neu ``` Instalacja za pomocą `yarn`. ``` yarn add ui-neu ``` Przykładowe importowanie komponentu `Card`. ``` import { Card } from 'ui-neu' ``` ## Documentacja Dokumentacja jest dostępna i zawiera informacje o "props", jak zacząć kontrybuowanie oraz poradnik jak kontrybuować do tego projektu. [Tutaj znajdziesz dokumentacje Neu UI](https://ui-neu.netlify.app/) ## Kontrybucja Jeśli jesteś zainteresowany współtworzeniem, każda pomoc od tworzenia dokumentacji po naprawianie blędów a nawet tworzenie nowych funkcjonalności jest mile widziana. - Pull requesty i ⭐ gwiazdki są mile widziane! - Przeczytaj [jak zacząć kontrybuować](CONTRIBUTING.md) aby dowiedzieć sie w jaki sposób możesz zacząć. - Jeśli szukasz bardziej szczegółowych informacji o tym jak współtworzyć rzuć okiem na [poradnik kontrybuowania](CONTRIBUTING_GUIDE.md) Szukasz pierwszego issue żeby zacząć? - Szukaj issues z etykietą [good first issue](https://github.com/daniel-norris/neu_ui/labels/good%20first%20issue) - Nie jesteś gotowy/a jeszcze do pisania kodu? Rzuć okiem na etykiety [dokumentacji](https://github.com/daniel-norris/neu_ui/labels/documentation). - Potrzebujesz pomocy lub wsparcia? Napisz do mnie, [Dan](https://twitter.com/danielpnorris) na Twitterze. ## Licencja Ten projekt jest objęty licencją [MIT](/LICENSE).