keepa-kit
v1.0.83
Published
This is a UI kit built with Material UI for Keepa in 2024. It provides a set of reusable components and styles to help create consistent and visually appealing user interfaces.
Downloads
275
Maintainers
Readme
Keepa UI Kit
This is a UI kit built with Material UI for Keepa in 2024. It provides a set of reusable components and styles to help create consistent and visually appealing user interfaces.
Key Concepts
- Vite + React + Storybook: To create an environment that allows for easy development, visualization, testing, and documentation of UI components.
- Material UI: A comprehensive React UI library that implements Google's Material Design.
- Rollup: To prepare the UI kit for production.
Installation
To install and use this UI kit, follow these steps:
Clone the repository:
git clone https://github.com/Keepa-ir/ui-kit.git
Navigate to the project directory:
cd ui-kit
Install dependencies:
npm install
Usage
To start the Storybook development server, run:
npm run storybook
This will open the Storybook interface in your default browser
where you can browse and interact with the available components.
To build the UI kit for production, run:
npm run build
The compiled assets will be available in the lib directory.
To publish compiled assets to NPM, first run:
npm run bump-version
then run:
npm publish
Contributing
We welcome contributions to this project!
If you find any issues or have suggestions for improvements, please feel free to email us.
License
This project is licensed under the MIT License