gabriel-queiroz / react-typescript-boilerplate

Boilerplate with React + Typescript + Webpack and more.

      

Boilerplate - React + Typescript + Webpack

Technologies   |    Configuration   |    Tests   |    Others   |   

🚀 Technologies

• React
• Typescript
• Webpack
• Babel
• Storybook
• Jest
• Cypress
• Eslint
• Prettier
• Commitizen
• Husky

🔧 Configuration

1. Install all dependencies with

$ npm install 

or using yarn

$ yarn

2. Start the webpack-dev-server

$ npm run dev

or using yarn

$ yarn dev

🔍 Tests

1. Run e2e tests with

$ npm run test:e2e

or using yarn

$ yarn test:e2e

2. Run e2e tests in terminal with

$ npm run test:e2e:run

or using yarn

$ yarn test:e2e:run

❗ If Cypress (yarn test:e2e) is still not installed after yarn. Install cypress with:

$ npx cypress install

3. Run unit tests with

$ npm run test

or using yarn

$ yarn test

🎁 Others commands

# Build for web (compiled to build/)
$ npm run build

# Run for web production (needs npm run build first)
$ npm run start

# Open storybook
$ npm run storybook

# Check Eslint errors
$ npm run lint

# Format all files with prettier
$ npm run format

# Commit using commitizen
$ npm run commit

or using yarn

# Build for web (compiled to build/)
$ yarn build

# Run for web production (needs yarn build first)
$ yarn start

# Open storybook
$ yarn storybook

# Check Eslint errors
$ yarn lint

# Format all files with prettier
$ yarn format

# Commit using commitizen
$ yarn commit