This repo serves as a template for starting new web app projects, using React and TypeScript. It provides sane defaults & tools for linting, tests, and building.

Included tools & technologies are:

• React
• ESLint
• Webpack
• Jest
• Prettier
• TypeScript
• Husky

Page components go into src/pages/* and UI components into src/components/*. Both pages and components follow the same structure, consisting of the following files:

• const.ts - exports the component CLASS_NAME and any other constants
• props.ts - provides defaultProps and propTypes
• types.ts - defines an interface for the component propTypes
• style.scss - component stylesheet, imported in index.tsx
• index.tsx - the component itself

• yarn start: starts the dev server and opens the index page in a browser
• yarn build: builds the application to the dist folder for Release
• yarn format: runs Prettier
• yarn lint: runs ESLint
• yarn test: runs Jest
• yarn test:coverage: runs Jest and outputs coverage results
• yarn test:watch: runs Jest and runs tests on changes
• yarn test:snapshots: runs Jest and updates snapshots
• yarn update-version: updates CHANGELOG.md, bumps & tags the version
• yarn prepare: installs Husky hooks
• yarn prepare-release: lints, tests, and builds
• yarn release: runs prepare-release and update-version

See CHANGELOG.md for more information.

Distributed under the MIT license. See LICENSE.md for more information.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request