Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/savourygin/chop-logic-components
React Components Library for Chop Logic project
https://github.com/savourygin/chop-logic-components
chop-logic react storybook styled-components typescript ui-components
Last synced: 2 months ago
JSON representation
React Components Library for Chop Logic project
- Host: GitHub
- URL: https://github.com/savourygin/chop-logic-components
- Owner: SavouryGin
- Created: 2024-01-01T14:23:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-29T21:05:05.000Z (3 months ago)
- Last Synced: 2024-11-29T21:07:23.614Z (3 months ago)
- Topics: chop-logic, react, storybook, styled-components, typescript, ui-components
- Language: TypeScript
- Homepage: https://savourygin.github.io/chop-logic-components
- Size: 6.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chop Logic Components
Welcome to **Chop Logic Components**, a comprehensive React components library packed with a variety of **styled components** and **custom hooks** that are easy to integrate into any React project.
## About the Library
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://savourygin.github.io/chop-logic-components)
- [Npm](https://www.npmjs.com/package/chop-logic-components)
## Getting Started
To get started with Chop Logic, install it via npm or yarn:
```bash
npm install chop-logic-components
# or
yarn add chop-logic-components
```
## Scripts
### `format`
Runs [Prettier](https://prettier.io/) to automatically format TypeScript files (`.ts` and `.tsx`) in the project. This script will write changes directly to the files.
```bash
npm run format
```
### `lint`
Runs ESLint to analyze the TypeScript code for potential errors and enforce coding standards. It automatically fixes issues where possible and uses the .gitignore file to ignore certain paths.
```bash
npm run lint
```
### `check-types`
Runs the TypeScript compiler (tsc) to perform type checking without generating output files. This script helps ensure that the code adheres to TypeScript's type safety.
```bash
npm run check-types
```
### `build`
Compiles the TypeScript code into JavaScript using the TypeScript compiler (tsc) and then builds the project using Vite.
```bash
npm run build
```
### `test`
Runs unit tests using Vitest, a fast testing framework designed for Vite projects.
```bash
npm run test
```
### `test:ci`
Runs the tests in continuous integration (CI) mode with Vitest, providing a streamlined output suitable for automated environments.
```bash
npm run test:ci
```
### `storybook`
Starts a local instance of Storybook for developing UI components. The Storybook interface will be available at http://localhost:6006.
```bash
npm run storybook
```
### `build-storybook`
Builds the static version of the Storybook for deployment, outputting the files to the storybook-static directory. The --quiet flag suppresses the build logs.
```bash
npm run build-storybook
```
### `prepare`
Runs the build script and then installs Husky hooks for managing Git hooks in the project.
```bash
npm run prepare
```