1.0.2 • Published 6 years ago
react-neucomponents v1.0.2
React Neu Components
React Neu Components is a React neumorphism components library designed to provide ready to use components following the neumorphism UI/UX trend.
Documentation
You will find the full documentation and examples of the component library here
Library installation
Dependencies
React Neu Components requires the installation of the @emotion/core and @emotion/styled packages:
npm install --save @emotion/core @emotion/styled
or
yarn add @emotion/core @emotion/styledPackage installation
To install the React Neu Components package, run the following command:
npm install --save react-neucomponents
or
yarn add react-neucomponentsContributing
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
Reactstyleguidistfor component visualization and documentationemotionfor component stylingjestfor testingeslintfor code lintingrollupfor bundling
Setup and launch the project
- Clone the project:
git clone https://github.com/ZanchiTheo/react-neucomponents.git- Install dependencies:
yarn install- Launch the styleguidist server:
yarn start- Access the project at localhost:6060