RawasUI is a React-based component library that utilizes Storybook for component display. It is designed to be developer-friendly, allowing developers to easily customize components to their specific requirements.
To get started with RawasUI, follow these steps:
- Clone the repository:
git clone https://github.com/rawasaditya/RawasUI.git - Install dependencies:
npm ci - Watch and compile SCSS files:
npm run scss - View components using Storybook:
npm run storybook - Build component library:
npm run build
We welcome contributions from the community to help improve RawasUI. If you'd like to contribute, please follow these guidelines:
If you find a bug, have a suggestion, or want to request a feature, please open an issue on our GitHub repository. Make sure to include as much detail as possible.
- Fork the repository and create a new branch for your contribution.
- Ensure your code follows the project's coding style and conventions.
- Write clear, concise commit messages.
- Make sure to add unit tests for your code.
- Ensure your code passes the existing tests and linting rules.
- Submit a pull request with your changes.
- Include a clear and descriptive title for your pull request.
- Provide a detailed description of the changes you've made.
- Reference any related issues in your pull request.
- Ensure your code is well-documented.
- Provide a screenshot of the change if possible.
- Follow the established coding style and conventions used in the project.
We appreciate your contributions and thank you for helping improve RawasUI!