chop-logic-components
Version:
Reusable React components and hooks for the Chop Logic project
68 lines (50 loc) • 4.89 kB
Markdown
# Chop Logic Components
[](https://opensource.org/licenses/MIT)
[](https://github.com/ChopLogic/chop-logic-components/actions/workflows/github-pages.yml)
[](https://codecov.io/gh/ChopLogic/chop-logic-components)
[](https://sonarcloud.io/summary/new_code?id=ChopLogic_chop-logic-components)
[](https://github.com/ChopLogic/chop-logic-components/actions/workflows/npm.yml)
[](CODE_OF_CONDUCT.md)
[](https://conventionalcommits.org)
Welcome to **Chop Logic Components**, a React components library packed with a variety of **styled
components** and **custom hooks** that are easy to integrate into any React project.
## ✨ Features
Chop Logic is designed to speed up development by providing reusable, accessible, and highly customizable components.
Whether you're building complex forms, creating dynamic layouts, or managing component logic with hooks, Chop Logic
Components has the tools to make it easier.
## 🔗 Links
- [Storybook Playground](https://choplogic.github.io/chop-logic-components)
- [NPM package](https://www.npmjs.com/package/chop-logic-components)
## 📦 Installation
To get started with Chop Logic, install it via npm or yarn:
```bash
npm install chop-logic-components
# or
yarn add chop-logic-components
```
## 📜 Available NPM Scripts
| Script | Description |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start` | Starts Storybook in development mode on port `6006` without opening a browser. |
| `build` | Builds the TypeScript types and compiles the library using Vite. |
| `build:storybook` | Builds a static version of Storybook into the `storybook-static` directory. |
| `prepare` | Runs the production build and sets up Husky git hooks. |
| `format` | Formats all TypeScript files using Prettier with the TypeScript parser. |
| `lint` | Runs ESLint on the project to report code style or quality issues. |
| `lint:fix` | Fixes auto-correctable ESLint issues and silences output. |
| `typecheck` | Performs a full type check without emitting output. |
| `test` | Runs unit tests using Vitest in watch mode (interactive). |
| `test:ci` | Runs tests once in CI mode and allows empty test sets. |
| `coverage` | Runs tests and generates a coverage report using Vitest. |
| `release:version` | Bumps the version (`patch`, `minor`, or `major`), commits the change, creates a Git tag, and pushes to `main`. Usage: `npm run release:version patch` |
## 🛠 Contributing
Contributions are welcome! If you find a bug or have an idea for improvement, feel free to open an issue or submit a
pull request. Please check the [Contribution guide](CONTRIBUTING.md) for additional info.
1. Fork the repository.
2. Clone your fork.
3. Create a new feature branch.
4. Implement and test your changes.
5. Submit a pull request!
---
Let's build better logic tools together! 🚀