Boilerplate ReactBook - Packaged

A complete boilerplate with all the tools needed for a publish NPM Package.

View Demo · Report Bug · Request Feature

About The Project

This project aims to help all developers who need a React project with Storybook already pre-configured with all the basic tools for a modern and high-performance application.

Built With

This project only has the base tools for development:

• Vite
• React
• Typescript
• Sass
• Storybook
• Vitest

Bonus

In addition to the technologies mentioned above, this template also includes:

• ESLint
• Prettier
• BEM

Do you want to do it differently?

If you want to create a project to be published as a web page, you can access my other boilerplate with all the necessary configurations: boilerplate-react-typescript-storybook

Getting Started

To start using this template is very simple! Clone the project.

git clone https://github.com/AndreLuizMag/boilerplate-react-storybook-npm-package.git

Prerequisites

Now check if you have all the tools needed to start development.

npm -v

Installation

After cloning the boilerplate, run the installation of all the packages in the project.

npm i

Usage

With all the packages installed, it's time to put the project into action.

Running the project

npm run dev

Starts the development server for the project.

Running ESLint

npm run lint

Executes ESLint to check for code quality and style issues.

Running Vitest

npm run test

Launches Vitest for automated testing.

Running Storybook

npm run sb

Starts Storybook for component development and testing.

Build project

npm run build

Builds the project for production deployment.

License

Distributed under the MIT License. See LICENSE for more information.