https://github.com/andikhadian/component-library
React component library
https://github.com/andikhadian/component-library
components-library reactjs storybook typescript
Last synced: 4 months ago
JSON representation
React component library
- Host: GitHub
- URL: https://github.com/andikhadian/component-library
- Owner: andikhadian
- Created: 2023-01-26T04:16:15.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-30T02:00:26.000Z (almost 3 years ago)
- Last Synced: 2024-04-26T17:23:09.514Z (over 1 year ago)
- Topics: components-library, reactjs, storybook, typescript
- Language: TypeScript
- Homepage: https://component-library-andikhadev.vercel.app
- Size: 1.28 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Component Library
[Explore the Components](https://component-library-andikhadev.vercel.app)
Table of Contents
- [🚀 Getting Started](#-getting-started)
- [☕ Usage](#-usage)
- [🌍 Browser Support](#-browser-support)
- [🍫 Examples & Documentation](#-examples--documentation)
- [🔨 Build](#-build)
- [🤝Contributing](#contributing)
## 🚀 Getting Started
Install the package using npm or yarn
```sh
yarn add @andikhadian/component-library
or
npm install @andikhadian/component-library
```
Run storybook
```sh
npm run storybook
```
Run the Unit tests
```sh
npm run test
```
## ☕ Usage
```tsx
import { Button } from "@andikhadian/component-library";
const App = () => {
return (
Hello Button
);
};
export default App;
```
## 🌍 Browser Support
|  |  |  |  |  |
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
| Chrome | Firefox | Microsoft Edge | Opera | Safari |
## 🍫 Examples & Documentation
For more thorough examples and the API details visit the [storybook](https://component-library-andikhadev.vercel.app)
## 🤝Contributing
Contributions, ideas and PR's are welcome!
1. [Fork it](https://github.com/andikhadian/component-library/fork)
2. Create your feature branch (`git checkout -b new-feature`)
3. Commit your changes (`git commit -am 'Add feature'`)
4. Push to the branch (`git push origin new-feature`)
5. Create a new Pull Request