GithubHelp home page GithubHelp logo

erdinhrmwn / neu_ui Goto Github PK

View Code? Open in Web Editor NEW

This project forked from daniel-norris/neu_ui

0.0 1.0 0.0 1 MB

Prototype and build projects faster using Neu UI - an open source React component library designed to neumorphic style. Built using React, Styled Components, Jest and Storybook.

Home Page: https://ui-neu.netlify.app/

License: MIT License

HTML 4.68% JavaScript 95.32%

neu_ui's Introduction

Neu UI

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

Prototype and build projects faster using Neu UI - the neumorphic React component library.

Translations

Contents

  • โ“ About
  • ๐Ÿš€ Getting Started
  • ๐Ÿ“ Documentation
  • ๐Ÿ‘ Contributing
  • โš–๏ธ Licence

About

Neu UI started life as a small side project exploring UI component design and development using neumorphic design.

The style was originally conceptualised by Alexander Plyuto in late 2019 and "neumorphism", a mixture between skeumorphism and material design, was coined by Michal Malewicz shortly afterwards.

For further information about the design, it's worthwhile taking a look at Alexander Plyuto's guide here.

The initial components have now been converted and extended to include a whole suite of initial controlled form and card components into a React library. It uses React under the hood, Storybook as a tool to visualise the components and Styled Components to well, style the components.

We are looking for anyone interested in contributing, for further information check out the contribution section below.

Getting Started

Installation

Installing using npm.

npm i ui-neu

Installing using yarn.

yarn add ui-neu

Import a component.

import { Card } from 'ui-neu'

Docs

Docs are available and include information on props, how to start contributing and a contribution guide.

View the Neu UI docs here

Contributing

If you're interested in contributing, then any support from documentation, to bugfixes to even new feature improvements is welcome.

  • Pull requests and โญ stars are welcome!
  • Read the start contributing guide to find out ways in which you can start contributing
  • If you are looking for more detailed information on how to contribute then take a look at our contribution guide

Looking for a first issue to take on?

  • Look out for good first issue labels
  • Not ready to make a code contribution yet? Then look out for our documentation labels
  • Need support or help? Reach out to me, Dan on Twitter

Licence

This project is MIT licenced.

neu_ui's People

Contributors

daniel-norris avatar momosetti avatar aejgardner avatar erdinhrmwn avatar luizcieslak avatar chaosex avatar tititesouris avatar gcoro avatar kartiksoneji avatar s0meon3 avatar jscastanos avatar mojiwa avatar petercr avatar ruandev avatar sprakash57 avatar tarunyadav1 avatar greygroot avatar huynhpl-1596 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.