Raisin UI Components
Welcome to Raisin UI Components! This repository contains a collection of React UI components built using TypeScript. It utilizes tools such as Rollup for bundling, Storybook for component development and documentation, Jest for testing, and Lerna for managing a monorepo structure.
Getting Started
To get started with the project, follow these steps:
Prerequisites
- Node.js (version 18 or higher)
Installation
-
Clone the repository:
git clone https://github.com/your-username/raisin-ui-components.git -
Navigate to the project's root directory:
cd raisin-ui-components -
Install root dependencies:
npm install -
Install library dependencies:
cd ./src; npm install
Development Workflow
The repository is structured as a monorepo managed by Lerna. Here are some useful commands for the development workflow:
npm run build: Builds the project using Rollup.npm run start: Starts the development server with Storybook.npm run test: Runs the test suite using Jest.npm run prepare(Optional): Sets up the project with husky.
Contributing
Contributions to Raisin UI Components are welcome! If you find any bugs, have feature requests, or want to contribute enhancements, please follow these steps:
Fork the repository. Create a new branch for your contribution. Make your changes and commit them. Push your changes to your forked repository. Open a pull request, providing a clear description of your changes. Please ensure that your contributions align with the project's coding standards and follow the existing style and conventions.