{"id":18516585,"url":"https://github.com/bryce-mcmath/react-soft-ui","last_synced_at":"2025-05-14T14:34:21.590Z","repository":{"id":57345049,"uuid":"451150857","full_name":"bryce-mcmath/react-soft-ui","owner":"bryce-mcmath","description":"React component library for neumorphic design","archived":false,"fork":false,"pushed_at":"2023-01-03T22:55:22.000Z","size":2833,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-20T20:35:50.870Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bryce-mcmath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-23T15:45:31.000Z","updated_at":"2022-03-15T06:49:01.000Z","dependencies_parsed_at":"2023-02-01T12:31:54.885Z","dependency_job_id":null,"html_url":"https://github.com/bryce-mcmath/react-soft-ui","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Freact-soft-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Freact-soft-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Freact-soft-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Freact-soft-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryce-mcmath","download_url":"https://codeload.github.com/bryce-mcmath/react-soft-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254160647,"owners_count":22024574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T16:03:10.912Z","updated_at":"2025-05-14T14:34:21.576Z","avatar_url":"https://github.com/bryce-mcmath.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-soft-ui\n\n\u003e React component library for soft / neumorphic design\n\n\u003c!-- Badges --\u003e\n\n\u003c!-- Screenshot --\u003e\n\n![Screenshot](https://github.com/bryce-mcmath/react-soft-ui/blob/main/docs/screenshot.png?raw=true)\n\nView the Storybook for these components [here](https://bryce-mcmath.github.io/react-soft-ui/)\n\n## Table of contents\n\n- [Usage](#usage)\n- [Getting started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installing and running](#installing-and-running)\n  - [Running the tests](#running-the-tests)\n- [Deployment](#deployment)\n- [Built with](#built-with)\n- [Contributing](#contributing)\n- [Versioning](#versioning)\n- [Release history](#release-history)\n- [Meta](#meta)\n- [License](#license)\n- [Known issues / bugs](#known-issues-/-bugs)\n- [Feature roadmap](#feature-roadmap)\n- [Acknowledgements](#acknowledgements)\n\n## Usage\n\n```\nnpm i react-soft-ui\n```\n\n```jsx\nimport React from \"react\";\n\nimport { SoftButton } from \"react-soft-ui\";\nimport \"react-soft-ui/dist/esm/index.css\";\n\nfunction App() {\n  return \u003cSoftButton\u003eButton\u003c/SoftButton\u003e;\n}\n\nexport default App;\n```\n\n## Getting started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes\n\n### Prerequisites\n\nWhat things you need to install the software and how to install them\n\nIf you don't have Node.js 14+ and npm installed, install them from [here.](https://nodejs.org/en/)\n\n### Installing and Running\n\nIn the root directory:\n\n```\nnpm install\n```\n\n```\nnpm run storybook\n```\n\n### Running the tests\n\n```\nnpm run test\n```\n\n## Built with\n\n- [React](https://reactjs.org/) - Front-end framework\n- [styled-components](https://styled-components.com/) - CSS-in-JS\n- [TypeScript](https://www.typescriptlang.org/) - Strongly-typed programming language that builds on JavaScript\n- [Storybook](https://storybook.js.org/) - UI component explorer\n- [rollup](https://rollupjs.org/guide/en/) - JavaScript module bundler\n- [Jest](https://jestjs.io/) - JavaScript testing framework\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/bryce-mcmath/react-soft-ui/fork\u003e)\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n\n## Versioning\n\n[SemVer](http://semver.org/) will only start being used for versioning once the base collection of components is complete (1.0.0). For the versions available, see the [tags on this repository](https://github.com/bryce-mcmath/react-soft-ui/tags).\n\n## Release history\n\n- 0.1.2\n  - WIP\n  - First few components\n- 0.1.1\n  - The first release\n  - Just the scaffolding of the library\n\n## Meta\n\nBryce McMath – bryce.mcmath.work@gmail.com\n\n[https://github.com/bryce-mcmath](https://github.com/bryce-mcmath)\n\n## License\n\nMIT\n\nSee the [LICENSE.md](LICENSE.md) file for details\n\n## Known issues / bugs\n\n- Infant library, still needs more experienced eyes to guide its development\n\n_To add an issue, start a new one [here.](https://github.com/bryce-mcmath/react-soft-ui/issues)_\n\n## Feature roadmap\n\n- Radio buttons\n- Checkbox\n- Switch\n- Select dropdown\n- Inputs\n- Choice group\n- Verticle and horizontal sliders\n- Verticle and horizontal progress bars\n- Circular progress bar\n\n_If you'd like to add a feature yourself, please see the [Contributing](#contributing) guidelines._\n\n## Acknowledgements\n\n- Shout out to all the attempts to build a neumorphic React library thus far, definitely drawing inspiration from some of them\n- There are some major drawbacks to neumorphic style that are very difficult to practically address but it's just too cool to ignore\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryce-mcmath%2Freact-soft-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryce-mcmath%2Freact-soft-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryce-mcmath%2Freact-soft-ui/lists"}