About

This is an NPM-based frontend React library designed for shared components, hooks, and other utilities. It simplifies and streamlines the development of web applications by providing reusable code for specific tasks, allowing developers to build applications more efficiently and with less effort.

The library is built with Webpack and features modern development tools like TypeScript for type safety, Storybook for component development, and Jest for testing. It integrates seamlessly with React, Material UI, and other contemporary web development technologies.

Available Scripts

In the project directory, you can run the following scripts:

npm run storybook

Runs Storybook in development mode.
Open http://localhost:6006/ to view it in the browser.
Storybook allows you to develop and test UI components in isolation.

You will also see any lint errors in the console.

npm test

Launches the test runner in interactive watch mode using Jest.
For more information on running tests, check the official Jest documentation.

npm run build

Builds the project for production using Webpack.
The build output is placed in the dist folder.
This script will clean the previous build, run the build process, and optimize the assets for deployment.

npm run lint

Runs ESLint to check for any code style issues or potential errors in the codebase.
The linter will report any warnings or errors in the console.

npm run clean

Removes the dist folder, cleaning up previous build artifacts to ensure a fresh start for the build process.

npm run build-storybook

Builds a static version of your Storybook documentation.
This is useful for deploying the Storybook UI in a production environment.

npm run docs

Generates documentation for the codebase using TypeDoc.
This will create an API documentation based on TypeScript definitions, which can be helpful for developers working with your code.