A very opinionated starter Create React App (CRA) template with Must-Have Libraries (MHL) including:
- React v17.0.2
- Type Checker - TypeScript ^4.2.3
- Preprocessors - Sass/SCSS
- State management - Redux Toolkit, Recoil
- CSS Framework - Material-UI
- CSS-in-JS Modules — Styled Components
- Router - React Router
- Unit Testing - Jest & Enzyme + Sinon
- E2E Testing - Jest & Puppeteer
- Folder structure
- Generate templates
- Format & Lint - ESLint & Prettier
- Useful utilities - Moment, Classnames, Serve, react-snap, React-Helmet, Analyzer Bundle, react-uuid.
Custom Templates, format, and ESLint configurations. The original Create React App README available here.
yarn create react-app your-project-name --template must-have-librariesOr;
npx create-react-app your-project-name --template must-have-librariesnpx package runner tool installs the most recent stable version of CRA from npm. (npx comes out of the box with yarn 5.2+)
--template parameter points to this template, note that cra-template- prefix will be omitted.
Create-React-App (CRA) is a great starter project for React, you can be up and running quickly. It includes vanilla flavor packages and other opinionated packages. Additionally, it has an option to include templates or you can create your own template.
CRA already made some decisions for us, for example; build tools: Webpack over Rollup or Parcel. Task Runners yarn scripts over gulp. CSS, JS, and Jest as the default, and so on.
After working & reviewing projects and libraries that help get the job done with React, it’s hard to stay neutral and not to form an opinion one way or another.
For example, when using the package manager what should you use: yarn or npm. When it comes to CSS preprocessor: Saas/SCSS, PostCSS, Less or Stylus, or maybe others. CSS Frameworks: use the main ones; Bootstrap or MaterialUI or a different one. The list goes on and on.
Another challenge I observe is that many libraries are not very easy to migrate to once you start without them so although you may not need them today, it may be worth looking into starting on the right foot.
The idea here is to help you set up CRA with the selection of certain opinionated libraries that will help you get the job done from a small project to a larger enterprise level.
Inside the project directory run:
yarn start- runs the app in the development mode. Open http://localhost:3000 to view it in the browser.yarn test- launches the test runner in the interactive watch mode.yarn build- builds the app for production to thebuildfolder.yarn build:serve- run a local static build using the production build using serve library. Installyarn install -g serve.yarn build:profile- profiling production build.yarn eject- exposes content ofreact-scriptpackageyarn lint- lints project files according to Airbnb — as part of their style guide 👍 — it provides an ESLint configuration that anyone can use and it is the standard.yarn fix- fix lints issues according to style guide set.yarn format- will format your code prettier using opinionated settings inside.prettierrcfile.yarn isready- will check if the code is ready for showtime (production), run lint, format and build.yarn test:e2e- run e2e integration testing with the help of Jest & Puppeteer.yarn test:e2e-watch- same as test:e2e just with a watcher.yarn test:e2e-alone- stand-alone e2e integration testing NodeJS script for testing using Puppeteer.yarn test:debug- debug your jest tests using the debugger statement, more info here.yarn coverage- this test is to create a coverage report at needs extra setting in order to work as expected.analyze- source-map-explorer to Analyzer Bundle.analyzer- uses cra-bundle-analyzer to Analyzer Bundle.
CRA template only support scripts and dependencies inside generated package.json. No devDependencies is possible on CRA template for now.
If you need bootstrap. Just add;
$ yarn add bootstrap
Uncomment import in index.tsx;
import 'bootstrap/dist/css/bootstrap.css';
More here: https://create-react-app.dev/docs/adding-bootstrap
Router via React Router v5.2.0 and is set on 'AppRouter.tsx' and included in 'index.tsx', read here.
The code is set for Recoil or Redux Toolkit you pick.
Unit Testing is supported with Enzyme that works with Jest. Additionally, Sinon - a standalone test spies, stubs and mocks that works with Enzyme & Jest.
Jest and Sinon serve the same purpose. So why add Sinon? The answer is that there are times that you may find one framework more natural and easier to work for the specific test you need than the other so it wouldn’t hurt to have both.
You can compare the list of APIs on Jest (https://jestjs.io/docs/en/api) and Sinon (https://sinonjs.org/releases/v9.2.0/)
The 'src/setupTests.ts' file is already configured to work with enzyme using the enzyme react adapter.
For snapshot -- update 'package.json';
// package.json
"jest": {
"snapshotSerializers": ["enzyme-to-json/serializer"]
}
Note: remember to update / delete 'src/App.test.tsx' in case you update 'App.tsx'
For instance to check if a component you added include in App.tsx;
import { shallow } from "enzyme";
import Calculator from "./components/SomeComponent/SomeComponent";
test('should render SomeComponent', () => {
const wrapper = shallow(<App />);
const calculator = wrapper.find(SomeComponent);
expect(calculator.exists()).toBe(true);
})
You can read more about unit testing: hello-jest-enzyme-ts
To run the tests:
$ yarn test
To set coverage we can use Jest. Jest allow us to create reports in different format and set where we want to collect these reports from (or not collect them from), as well as ensure the coverageThreshold. Take a look at my 'package.json' settings;
To get testing coverage report, you need to include the following settings in your 'package.json' file;
// package.json
"jest": {
"coverageReporters": [
"json",
"text",
"html",
"lcov"
],
"collectCoverageFrom": [
"src/**/*.{js,jsx,ts,tsx}",
"!src/**/*/*.d.ts",
"!src/**/*/Loadable.{js,jsx,ts,tsx}",
"!src/**/*/types.ts",
"!src/**/store.ts",
"!src/index.tsx",
"!src/serviceWorker.ts",
"!<rootDir>/node_modules/",
"!**/templates/**",
"!**/template/**"
],
"coverageThreshold": {
"global": {
"branches": 50,
"functions": 50,
"lines": 50,
"statements": 50
}
}
In this example, I am enforcing 50% 'coverageThreshold', when I set these it can ensure that I am testing in within my threshold or get an error. That can come handy, because we can set these setting to ensure that every single function, statement, lines and branches get at least 50% or even set it to 100% test coverage.
E2E testing provided by Jest & Puppeteer. Check the E2E folder for stand-alone and testing app.test.tsx component. You can read more about it here.
To run the E2E stand-alone and Jest & Puppeteer tests run;
$ yarn test:e2e
And;
$ yarn test:e2e-alone
Lint set according to Airbnb style guide — as part of their style guide. Feel free to tweak .eslintrc.
Prettier is set using my opinionated settings, feel free to tweak prettier rules inside config file .prettierrc to match your code style.
generate-react-cli help speed up productivity in React projects, feel free to tweak rules inside the config file generate-react-cli.json to match your needs.
There are many options to debug such as using this run script and placing debugger statements
$ yarn test:debug. Read how on how to debug the App in this article.
For Profiling you can use methods such as Chrome DevTools or the <Profile> Component. Here is an example;
// src/AppRouter.tsx
import { Profiler } from 'react'
const AppRouter: FunctionComponent = () => {
return (
<Profiler onRender={(id, phase, actualTime, baseTime, startTime, commitTime) => {
console.log(`${id}'s ${phase} phase:`);
console.log(`Actual time: ${actualTime}`);
console.log(`Base time: ${baseTime}`);
console.log(`Start time: ${startTime}`);
console.log(`Commit time: ${commitTime}`);
}}>
<Router>
<RecoilRoot>
<Suspense fallback={<span>Loading...</span>}>
<Switch>
<Route exact path="/" component={App} />
</Switch>
</Suspense>
</RecoilRoot>
</Router>
</Profiler>
)
}
Read more about profiling options here.
- Prerender - almost static pages using
react-snap. See comments in:src/index.tsx; - Precache - src/index.tsx >
serviceWorker.register() - Analyzer Bundle -
yarn add -D cra-bundle-analyzer-> Create the report:npx cra-bundle-analyzer
Read more about optimizing in this article.
‘bundle-analyzer’ (https://github.com/svengau/cra-bundle-analyzer), is my prefer bundle analyzer, it's more colorful and includes all the bundles in one page instead of calling them one by one with source-map-explorer.
Install (yarn add --dev cra-bundle-analyzer) & you use the run script:
$ yarn analyzer
Other option is to use source-map-explorer (yarn add --dev source-map-explorer);
$ yarn analyze
Adding all these libraries from this project comes with a cost of 87 kb out of the gate (54 kb of that for Recoil).
Important - if you don't use Recoil - remove it:
$ yarn remove recoil
React v17 costs are a split between React library itself parsed cost 129.17KB that is broken down to parsed 8.67kb (or 2.4 gzipped) and the React DOM parsed 120.5kb (or 38kb gzipped).
If you can use help with your React project or have a burning question, or an issue in your project that needs help with, I invite you to hire me as your Coach. My strategy is 100% results-oriented. If you want to sample how I work 1-on-1, let’s schedule a one-time deep dive Consultation.
- Take the interactive d3 and React Course
- Take the Digital Course & get a 40 pages React book
- Check out React Router and Material-UI Digital Course & get 35 pages eBook.
- View the article on Medium
- Visit my portfolio
If you like this library, don't be shy to star it 🙏