Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 3.38 KB

README.md

File metadata and controls

85 lines (55 loc) · 3.38 KB

Neu UI

github issues shield releases github licence github commit activity shield twitter repository example

Twórz prototypy i projekty szybciej używając Neu UI - neumorficznej biblioteki komponentów react.

Tłumaczenia

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 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.

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

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ć 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

Szukasz pierwszego issue żeby zacząć?

  • Szukaj issues z etykietą good first issue
  • Nie jesteś gotowy/a jeszcze do pisania kodu? Rzuć okiem na etykiety dokumentacji.
  • Potrzebujesz pomocy lub wsparcia? Napisz do mnie, Dan na Twitterze.

Licencja

Ten projekt jest objęty licencją MIT.