React Starter

This is an opinionated starter kit for quickly bootstrapping client-side React projects written in TypeScript.

A demo of this starter kit can be found on https://react-starter-mhxbe.vercel.app.

Installation

git clone [email protected]:mhxbe/react-starter.git
npm install

Usage

Development server

npm start

Production build

npm run build

Structure

src/

This folder houses our app files and logic.

dist/

This folder outputs a production-optimized static build of our app. It's generated from src/index.tsx.

node_modules/

This folder contains all of the app's dependencies which are defined in package.json's dependencies & devDependencies fields.

Progressive Web App (PWA)

Progressive Web Apps (PWA) are supported through a Service Worker which is present in this starterkit. It's powered by Google's Workbox via its workbox-webpack-plugin. The service-worker.ts will be enriched and copied to dist/sw.js by workbox-webpack-plugin's InjectManifest() which can be found in webpack.config.ts. The registration of the Service Worker happens in src/index.tsx.

Routing

React Router is a collection of navigational components that compose declaratively with your application. This enables us to use routing in our SPA.

We're using a public/.htaccess file to implement a "Catch All" approach so we can use nice URLs. If you're not using apache but nginx for example, make sure to add rewrites in your config.

SEO (react-helmet)

React Helmet is a document head manager for React. This way we can dynamically set meta-tags, title, ... in the document head.

There's a caveat. Every React "Page"-component must make use of a <Helmet> to set the description meta-tag. This meta-tag is not present in public/index.html so each page is responsible for rendering one.

Open Graph

Some Open Graph meta-tags are present in public/index.html to make sure your app will look nice when it's shared on Facebook & Twitter.

The images that are used on Facebook & Twitter can be found in src/images/open-graph/.

• Facebook: public/images/open-graph/facebook.open-graph.png
• Twitter: public/images/open-graph/twitter.open-graph.png

Make sure to respect the following filename pattern:

• {facebook|twitter}.open-graph.{png|jpg|jpeg}.

Why? We want to exclude these images in our Service Worker. All images ending with .open-graph.{png|jpg|jpeg} will be ignored.

Check out the exclude-field in InjectManifest() which can be found in webpack.config.ts.

Configurations

webpack (webpack.config.ts)

webpack is a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset.

TypeScript (tsconfig.json)

TypeScript is a typed superset of JavaScript that compiles to a backwards compatible version of JavaScript in current and older browsers or environments. It's configured in tsconfig.json

Styling

Tailwind CSS is a utility-first CSS framework for rapidly building custom user interfaces. It's configured in tailwind.config.js & .postcssrc.json.

Multilinguality (i18n)

react-i18next is a powerful internationalization framework for React / React Native which is based on i18next.

It uses translation-files in json format which can be found in public/locales. It's configured in src/config/i18n.ts.

Testing

Jest is a JavaScript Testing Framework with a focus on simplicity. It's configured in jest.config.ts.

babel-jest is automatically installed when installing Jest and will automatically transform files because a babel configuration exists in this project.

React Testing Library is a very light-weight solution for testing React components. It provides light utility functions on top of react-dom and react-dom/test-utils, in a way that encourages better testing practices.

Linting

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It is configured in .eslintrc.json. Specific files & folders can be ignored by adding them to .eslintignore.

EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. It is configured in .editorconfig.

Browserslist

Browserslist shares target browsers versions between different front-end tools. Currently it's used in combination with eslint-plugin-compat which will give linting errors/warnings when non-compatible code is written. It is configured in .browserslistrc.

Remember to regularly run the following command to make sure definitions like "last 2 versions" stay up to date.

npx browserslist@latest --update-db

More info about this can be found on Browserlist: Browsers Data Updating

Git hooks

Husky makes it easy to set up Git hooks.

Currently 2 hooks are used:

• .husky/pre-commit
• .husky/commit-msg

Prettier is an opinionated code formatter which is configured in .prettierrc.json. Specific files & folders can be ignored by adding them to .prettierignore.

Pretty Quick runs Prettier on your changed files when Git's pre-commit hook is triggered.

The combination of husky, prettier & pretty-quick makes sure that commits are clean so our code-base stays consistent.

Conventional Commits

Conventional Commits are enforced and automated with commitizen & commitlint. On each commit, .husky/commit-msg's Git-hook will lint the commit message to check if it follows @commitlint/config-conventional's rules and conventions.

Their configurations can be found in .czrc & .commitlintrc.json.

A handy npm-script is also present to automatically commit conventional with a cli prompt:

npm run commit

Sonar

SonarCloud is an open source cloud platform for continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security vulnerabilities. It is configured in sonar-project.properties.

A Github Action is used to generate a test-report.xml in Sonar's Generic Test Data and upload it to SonarCloud. It is configured in .github/workflows/sonar.yml.

For this project, the Sonar way recommended Quality Profile is used.

Git

.gitignore file specifies intentionally untracked files that Git should ignore. Files already tracked by Git are not affected.

.gitattributes file is a simple text file that gives attributes to pathnames. We use this especially for enforcing LF line endings.

• text The text attribute enables and controls end-of-line normalization. When a text file is normalized, its line endings are converted to LF in the repository.

• eol This attribute sets a specific line-ending style to be used in the working directory. It enables end-of-line conversion without any content checks, effectively setting the text attribute.

Dependency management

Renovate facilitates automated dependency updates. Make sure to configure renovate for your project if you want to use it. The local project configuration can be found in .renovaterc.json.

Prevent specific dependency updates

You can use ignoreDeps in .renovaterc.json to prevent Renovate from updating specific dependencies.

{
  "ignoreDeps": ["eslint", "eslint-config-base"]
}

License

This project is open source and available under the MIT License.