react-typescript-npm-boilerplate

Start your next react typescript npm package project in seconds

A highly scalable, focus on performance and best practices

Browse in Github1s

---

Built with

• ReactJS v17.0.2


• TypeScript


• Eslint


• Prettier


• Story Book


• Husky-Git hooks


• Jest


• Rollup.js


• Faker.js


• and some ✨Magic ✨

Usage

This boilerplate requires Node.js v10+ to run.

Install the dependencies and devDependencies and start the storybook.

git clone <clone url>

cd react-typescript-npm-boilerplate

npm i

npm run storybook

For production build

npm run build

For unit testing

npm run test

For unit test & generate JUnit report

npm run test:junit

For lint check and fix

npm run lint

npm run lint:fix

For build storybook

npm run build-storybook

How git commit works?

Since we are using Conventional-commits. There should be subject mentioned in the below list.

git commit -m "<subject>: <message>"

For example:

git commit -m "chore: commit message here"

List of commit subjects:

• build


• ci


• chore


• docs


• feat


• fix


• perf


• refactor


• revert


• style


• test

Pre-commit checks

Everytime you commit the code, there will be following checks:

• Eslint check


• Prettier format check


• Unit test check


• Build success check

You can add/remove the checks in .husky/pre-commit file

---

Want to contribute? Great!

License

MIT (Free software)