2.0.0 • Published 1 year ago

react-quick-calculator v2.0.0

Weekly downloads
-
License
-
Repository
github
Last release
1 year ago

React Quick Calculator

GitHub

Description

React Quick Calculator is a simple calculator component specifically designed for React applications.

Features

  • Lightweight Component: Easy to integrate into any React application.
  • TypeScript Support: Built with TypeScript for type safety and better maintainability.
  • Vite for Development: Fast and efficient development server with Vite.
  • Testing Integration: Includes Jest and React Testing Library for comprehensive testing.
  • Linting: Ensures code quality with ESLint and Stylelint.
  • Storybook: Develop and document UI components in isolation.

Installation

To get started with React Quick Calculator, clone the repository and install the dependencies:

git clone https://github.com/rafael-lino/react-quick-calculator.git
cd react-quick-calculator
pnpm install

Scripts

Here are some useful commands you can run:

  • Development: Start the development server.

    npm run dev
  • Build: Create a production build of the library.

    npm run build
  • Test: Run the test suite.

    npm test
  • Preview Build: Preview your production build.

    npm run preview
  • Start Storybook: Run Storybook for component development.

    npm run start:docs

Keywords

  • React
  • TypeScript
  • Vite
  • ESLint
  • Testing Library
  • Storybook

Peer Dependencies

This library requires the following peer dependencies:

  • react (>=18.2.0)
  • react-dom (>=18.2.0)

Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue for any enhancements or bugs you encounter.

License

This project is licensed under the MIT License.

For more information, visit the GitHub repository.