🚀 Overview

Storykit is an ongoing React library project built with Storybook, featuring custom components and hooks

🌟 Features

• Reusable custom hooks for state management and side effects
• Custom React components
• Live demo and documentation with Storybook
• CI/CD integration with Github Actions

📥 Installation

npm install storykit@github:Linh-Tran-0312/storykit

💻 Usage

import { Button } from 'storykit';

const App = () => (
  <Button onClick={() => alert('Clicked!')}>Click Me</Button>
);

🔧 Development

Setup

Run on local

git clone https://github.com/Linh-Tran-0312/storykit.git
cd storykit
npm install
npm run story

Run on docker

git clone https://github.com/Linh-Tran-0312/storykit.git
cd storykit
docker compose build
docker compose up

Commands

Build story

npm run build-story

Build library

npm run build

Run eslint

npm run lint
npm run lint:fix

Run unit test

npm run test

🙏 Acknowledgements

React: the foundation for building components and hooks.
Storybook: providing a seamless environment to showcase and test components.
Typescript: enabling type safety and maintainability of the code base.
Vite: for its fast and efficient development and build tool.
ESlint and Prettier: ensuring code quality and consistent format across the project.
Rollup: for bundling the library.
Jest and Testing library: providing a robust tool to write and run unit tests.
Docker: A containerization tool for easy setup.