Giter Club home page Giter Club logo

react-typescript-npm-boilerplate's Introduction

react-typescript-npm-boilerplate

react-typescript-npm-boilerplate

Start your next react typescript npm package project in seconds

A highly scalable, focus on performance and best practices

Open in Visual Studio Code

Browse in Github1s

Built with

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)

react-typescript-npm-boilerplate's People

Contributors

sivakumar00 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.