@oncehub/ui-react

once-ui-react

React component library for Oncehub

Usage

npm install @oncehub/ui-react

Development

1. Storybook is automatically deployed to Github Pages when pushing to main.
2. Package is automatically pushed to npm when creating a new release on Github. Check out the release section in the repo. Read more about releases here.

Tools

• ⚛️ React 18
• 📚 Storybook 7 - Components preview
• 🖌️ Tailwind CSS 3
• ⏩ Vite - Run and build the project blazingly fast!
• ⚡ Vitest - Components Unit Testing
• 📐 ESLint & Prettier - Formatting and Linting
• 🌟 Typescript
• 🐶 Husky & Lint Staged - Pre-commit Hooks
• ⏰ Release Please — Generate the changelog with the release-please workflow
• 👷 Github Actions — Releasing versions to npm

Main Scripts

• dev: Bootstrap the Storybook preview with Hot Reload.
• build: Builds the static storybook project.
• build:lib: Builds the component library into the dist folder.
• lint:fix: Applies linting based on the rules defined in .eslintrc.js.
• format:prettier: Formats files using the prettier rules defined in .prettierrc.
• test: Runs testing using watch mode.
• test:cov: Runs testing displaying a coverage report.

Acknowledgments

The project has been scaffolded using vite-component-library-template

License

MIT