isabella232 / react-app-rif-template Goto Github PK

react-app-rif-template

React.js template with Typescript, Sass, Enzyme, ESlint and CircleCI

Use this template to create a create-react-app with configuration ready for:

• Typescript - static type definitions for JavaScript
• Sass - CSS pre-processor
• Enzyme - JavaScript Testing utility for React*
• ESLint - linter tool for identifying and reporting on patterns in JavaScript
• CircleCI - continuous integration and delivery platform

Usage

This repo is to be used as a tempalte. It has setup for the tools mentioned above, cinluding CircleCI flow

1. Create a new repo using this one as a template

2. Update the shields on the header to point your urls

3. Start coding!

Available Scripts

yarn

Install project dependencies

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

yarn test

Runs the tests, displays coverage, and runs the linter. See below for more specific commands

yarn test:watch

Launches the test runner in the interactive watch mode.

yarn test:coverage

Runs the test coverage and saves the report in thecoverage folder.

yarn lint

Runs the linter and returns status.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

CI scripts

yarn test:ci

Runs the test coverage and saves the report in thereports folder. Uses maxWorkers=2 - CircleCI recommendation

yarn test:ci

Runs the linter and saves the report in thereports folder.

Knowledge base

This project was bootstrapped with the Typescript tempalte of Create React App and added Eslint, CircleCI, and Enzyme testing utility.

Current React.js version: v17.0.1, but Enzyme is set up for v16 - this will be upgraded when Enzyme releases a new version.