Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 4.74 KB

README.md

File metadata and controls

76 lines (48 loc) · 4.74 KB

Neu UI

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

Δημιούργησε πρωτότυπα και πρότζεκτς ταχύτερα χρησιμοποιώντας Neu UI - την βιβλιοθήκη νεομορφικών (neumorphic) react συστατικών.

Περιεχόμενα

  • ❓ Περιγραφή
  • 🚀 Πρώτα βήματα
  • 📝 Τεκμηρίωση
  • 👏 Συνεισφορά
  • ⚖️ Άδεια

Περιγραφή

Η Neu UI ξεκίνησε σαν ενα μικρό δευτερεύον πρότζεκτ που ερευνά την σχεδίαση και την ανάπτυξη συστατικών διεπαφής χρήστη, χρησιμοποιώντας τις αρχές της νεομορφικής σχεδίασης.

Οι αρχές επινοήθηκαν αρχικά απο τον Alexander Plyuto στο τέλος του 2019 και ο νεομορφισμός, ένα μείγμα σκευομορφισμού (skeumorphism) και υλικού σχεδιασμού (material design), απο τον Michal Malewicz λίγο αργότερα.

Για περισσότερες πληροφορίες σχετικά με την σχεδίαση, αξίζει να ρίξεις μια ματιά στον οδηγό του Alexander Plyuto εδώ.

Τα αρχικά συστατικά έχουν μετατραπεί και έχουν επεκταθεί ώστε να περιέχουν ολόκληρη την σουίτα συστατικών ελεγχόμενων φορμών και καρτών σε μια βιβλιοθήκη React. Χρησιμοποιεί React, Storybook σαν εργαλείο απεικόνισης των συστατικών και Styled Components προφανώς για το στύλ των συστατικών.

Ψάχνουμε για οποιονδήποτε ενδιαφέρεται να συνεισφέρει. Για περισσότερες πληροφορίες δες την ενότητα Συνεισφορά παρακάτω.

Πρώτα βήματα

Εγκατάσταση

Εγκατάσταση χρησιμοποιώντας npm.

npm i ui-neu

Εγκατάσταση χρησιμοποιώντας yarn.

yarn add ui-neu

Εισαγωγή συστατικού.

import { Card } from 'ui-neu'

Τεκμηρίωση

Η τεκμηρίωση είναι διαθέσιμη και περιέχει πληροφορίες σχετικά με τα props, τα πρώτα βήματα για αυτούς που θέλουν να συνεισφέρουν και εναν οδηγό συνεισφοράς.

Δες την τεκμηρίωση της Neu UI εδώ

Συνεισφορά

Αν ενδιαφέρεσαι να συνεισφέρεις, τότε κάθε βοήθεια στην τεκμηρίωση, διόρθωση bugs ή ακόμα και ανάπτυξη νέων χαρακτηριστικών είναι ευπρόσδεκτη.

  • Pull requests και ⭐ stars είναι ευπρόσδεκτα!
  • Διάβασε τα πρώτα βήματα συνεισφοράς για να μάθεις τρόπους με τους οποίους μπορείς να αρχίσεις να συνεισφέρεις
  • Αν ψάχνεις για πιο λεπτομερείς πληροφορίες σχετικά με την συνεισφορά ρίξε μια ματιά στον οδηγό συνεισφοράς

Ψάχνεις για την πρώτη σου δουλειά;

  • Ψάξε χρησιμοποιώντας τις good first issue ετικέτες
  • Δεν νιώθεις έτοιμος να συνεισφέρεις με κώδικα; Τότε ψάξε χρησιμοποιώντας τις documentation ετικέτες
  • Θέλεις υποστήριξη ή βοήθεια; Έλα σε επαφή με εμένα, Dan στο Twitter

Άδεια

Αυτό το πρότζεκτ χρησιμοποιεί την άδεια MIT.