https://github.com/Sivakumar00/react-typescript-npm-boilerplate

A react typescript npm component boilerplate
https://github.com/Sivakumar00/react-typescript-npm-boilerplate

boilerplate-template npm react typescript

Last synced: 3 months ago
JSON representation

A react typescript npm component boilerplate

• Host: GitHub
• URL: https://github.com/Sivakumar00/react-typescript-npm-boilerplate
• Owner: Sivakumar00
• License: mit
• Created: 2021-10-01T08:25:01.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-05T09:16:44.000Z (about 3 years ago)
• Last Synced: 2024-01-24T07:05:46.517Z (10 months ago)
• Topics: boilerplate-template, npm, react, typescript
• Language: TypeScript
• Homepage:
• Size: 16.6 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-projects-boilerplates - React Typescript npm boilerplate - shaking and airbnb eslint rules (JavaScript)

README

        


 

 

 

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)