Skip to content
This repository was archived by the owner on Apr 6, 2021. It is now read-only.

nfq-eta/react-typescript

Repository files navigation

React & typescript boilerplate Build is passing? Coverage Status Waffle.io

Why?

Make it fast as possible. Current development environment starts in ~10s Build time as fast as possible Bundle size should be minimum as possible

How to start

  1. yarn Install dependencies
  2. yarn start Start development
  3. yarn start:storybook Start storybook
  4. yarn build Build for production
  5. Install wallaby plugin for you IDE
  6. Configure wallaby test runner
  7. yarn test Run tests to check if everything is working
  8. yarn prepush Run before each push

What's inside

Available commands

Command Description
yarn start Start development enviroiment
yarn start:storybook Start storybook
yarn lint Lint typescript files
yarn lint:css Lint scss/css files
yarn test Start test enviroiment for development
yarn test:coverage Display tests coverage

Contribute

Git Commit Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the our change log.

The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard (Commitizen). To use the wizard, run yarn run cm in your terminal after staging your changes in git.

A detailed explanation borrowed from angular and can be found in this document.

Todo

  • Automate Changelist.md
  • E2E Tests
  • i18n
  • Red box for react errors?
  • Server side rendering