Giter VIP home page Giter VIP logo

neumorphism-react's Introduction

Neumorphism React

Neumorphism React is a React neumorphism components library designed to provide ready to use components following the neumorphism UI/UX trend.

Presentation picture

Documentation

You will find the full documentation and examples of the component library here

! Notice that the documentation is in building state so, some things may be missing !

The library is available on npm

Library installation

Dependencies

Neumorphism React requires the installation of the @emotion/core and @emotion/styled packages:

npm install --save @emotion/core @emotion/styled

or

yarn add @emotion/core @emotion/styled

Package installation

To install the Neumorphism React package, run the following command:

npm install --save neumorphism-react

or

yarn add neumorphism-react

Contributing

The project repository is available here

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Tech stack

  • React
  • styleguidist for component visualization and documentation
  • emotion for component styling
  • jest for testing
  • eslint for code linting
  • rollup for bundling

Setup and launch the project

  • Clone the project:
git clone https://github.com/ZanchiTheo/neumorphism-react.git
  • Install dependencies:
yarn install
  • Launch the styleguidist server:
yarn start

License

MIT

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.