|
1 | 1 | # react-soft-ui
|
2 |
| -React component library for neumorphic design |
3 | 2 |
|
4 |
| -🚧 WIP 🚧 |
| 3 | +> React component library for soft / neumorphic design |
| 4 | +
|
| 5 | +<!-- Badges --> |
| 6 | + |
| 7 | +<!-- Screenshot --> |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +## Table of contents |
| 12 | + |
| 13 | +- [Usage](#usage) |
| 14 | +- [Getting started](#getting-started) |
| 15 | + - [Prerequisites](#prerequisites) |
| 16 | + - [Installing and running](#installing-and-running) |
| 17 | + - [Running the tests](#running-the-tests) |
| 18 | +- [Deployment](#deployment) |
| 19 | +- [Built with](#built-with) |
| 20 | +- [Contributing](#contributing) |
| 21 | +- [Versioning](#versioning) |
| 22 | +- [Release history](#release-history) |
| 23 | +- [Meta](#meta) |
| 24 | +- [License](#license) |
| 25 | +- [Known issues / bugs](#known-issues-/-bugs) |
| 26 | +- [Feature roadmap](#feature-roadmap) |
| 27 | +- [Acknowledgements](#acknowledgements) |
| 28 | + |
| 29 | +## Usage |
| 30 | + |
| 31 | +``` |
| 32 | +npm i react-soft-ui |
| 33 | +``` |
| 34 | + |
| 35 | +```jsx |
| 36 | +import React from "react"; |
| 37 | + |
| 38 | +import { SoftButton } from "react-soft-ui"; |
| 39 | +import "react-soft-ui/dist/esm/index.css"; |
| 40 | + |
| 41 | +function App() { |
| 42 | + return <SoftButton>Button</SoftButton>; |
| 43 | +} |
| 44 | + |
| 45 | +export default App; |
| 46 | +``` |
| 47 | + |
| 48 | +## Getting started |
| 49 | + |
| 50 | +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes |
| 51 | + |
| 52 | +### Prerequisites |
| 53 | + |
| 54 | +What things you need to install the software and how to install them |
| 55 | + |
| 56 | +If you don't have Node.js 14+ and npm installed, install them from [here.](https://nodejs.org/en/) |
| 57 | + |
| 58 | +### Installing and Running |
| 59 | + |
| 60 | +In the root directory: |
| 61 | + |
| 62 | +``` |
| 63 | +npm install |
| 64 | +``` |
| 65 | + |
| 66 | +``` |
| 67 | +npm run storybook |
| 68 | +``` |
| 69 | + |
| 70 | +### Running the tests |
| 71 | + |
| 72 | +``` |
| 73 | +npm run test |
| 74 | +``` |
| 75 | + |
| 76 | +## Built with |
| 77 | + |
| 78 | +- [React](https://reactjs.org/) - Front-end framework |
| 79 | +- [styled-components](https://styled-components.com/) - CSS-in-JS |
| 80 | +- [TypeScript](https://www.typescriptlang.org/) - Strongly-typed programming language that builds on JavaScript |
| 81 | +- [Storybook](https://storybook.js.org/) - UI component explorer |
| 82 | +- [rollup](https://rollupjs.org/guide/en/) - JavaScript module bundler |
| 83 | +- [Jest](https://jestjs.io/) - JavaScript testing framework |
| 84 | + |
| 85 | +## Contributing |
| 86 | + |
| 87 | +1. Fork it (<https://github.com/bryce-mcmath/react-soft-ui/fork>) |
| 88 | +2. Create your feature branch (`git checkout -b feature/fooBar`) |
| 89 | +3. Commit your changes (`git commit -am 'Add some fooBar'`) |
| 90 | +4. Push to the branch (`git push origin feature/fooBar`) |
| 91 | +5. Create a new Pull Request |
| 92 | + |
| 93 | +## Versioning |
| 94 | + |
| 95 | +[SemVer](http://semver.org/) will only start being used for versioning once the base library is complete (1.0.0). For the versions available, see the [tags on this repository](https://github.com/bryce-mcmath/react-soft-ui/tags). |
| 96 | + |
| 97 | +## Release history |
| 98 | + |
| 99 | +- 0.1.2 |
| 100 | + - WIP |
| 101 | + - First few components |
| 102 | +- 0.1.1 |
| 103 | + - The first release |
| 104 | + - Just the scaffolding of the library |
| 105 | + |
| 106 | +## Meta |
| 107 | + |
| 108 | + |
| 109 | + |
| 110 | +[https://github.com/bryce-mcmath](https://github.com/bryce-mcmath) |
| 111 | + |
| 112 | +## License |
| 113 | + |
| 114 | +MIT |
| 115 | + |
| 116 | +See the [LICENSE.md](LICENSE.md) file for details |
| 117 | + |
| 118 | +## Known issues / bugs |
| 119 | + |
| 120 | +- Infant library, still needs more experienced eyes to guide its development |
| 121 | + |
| 122 | +_To add an issue, start a new one [here.](https://github.com/bryce-mcmath/react-soft-ui/issues)_ |
| 123 | + |
| 124 | +## Feature roadmap |
| 125 | + |
| 126 | +- Radio buttons |
| 127 | +- Checkbox |
| 128 | +- Switch |
| 129 | +- Select dropdown |
| 130 | +- Inputs |
| 131 | +- Choice group |
| 132 | +- Verticle and horizontal sliders |
| 133 | +- Verticle and horizontal progress bars |
| 134 | +- Circular progress bar |
| 135 | + |
| 136 | +_If you'd like to add a feature yourself, please see the [Contributing](#contributing) guidelines._ |
| 137 | + |
| 138 | +## Acknowledgements |
| 139 | + |
| 140 | +- Shout out to all the attempts to build a neumorphic React library thus far, definitely drawing inspiration from some of them |
| 141 | +- There are some major drawbacks to neumorphic style that are very difficult to practically address but it's just too cool to ignore |
| 142 | + |
| 143 | +--- |
0 commit comments