React App

This project was bootstrapped with Nimble React template.

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.

yarn test: Launches the test runner in the interactive watch mode. See the section about running tests for more information.

yarn test:coverage: Both Unit Tests (Jest) and UI Tests (cypress) generate test coverage analytics. The below command runs all tests and merges both coverage files into a single report.

Use the .nyc_output/out.json artefact in your CI/CD pipeline to reuse the code coverage data.

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.

yarn eject: If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project. Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them.

Note: this is a one-way operation. Once you eject, you can’t go back!

yarn lint: Run ESLint in the project.

yarn lint:fix: Fix auto-correctable ESLint errors in the project.

yarn stylelint: Run Stylelint in the project.

yarn stylelint:fix: Fix auto-correctable Stylelint errors in the project.

yarn codebase:lint: Run ESLint and Stylelint together in the project.

yarn codebase:fix: Fix auto-correctable ESLint and Stylelint errors together in the project.

yarn cypress:run: Runs Cypress tests to completion. By default, cypress run will run all tests headlessly in the Electron browser. Check options

yarn cypress:open: Opens the Cypress Test Runner. Check options

Localization

This project uses the react-i18next package to handle the project locales.

To add a new language

Add the new language bigram to the supportedLanguages array in src/i18n.ts — use this array to list all available languages in a 'change language' component
Add the new translation file in public/locales/{lang_bigram}/translation.json

To change the default fallback language

Either edit the value of the environment variable REACT_APP_DEFAULT_LANGUAGE (cf. the env.example file)
Either directly edit the const DEFAULT_FALLBACK_LANGUAGE in src/i18n.ts

Deployment

GitHub Actions for Netlify

The .github/workflow folder already includes GitHub Actions to deploy previews and releases of your app in Netlify.

How to use it?

Create a new empty application in Netlify (use Drag&Drop and drop their demo project)
Configure the following action secrets in the Github repository:

NETLIFY_SITE_ID available in the Site settings tab.
NETLIFY_AUTH_TOKEN: created under User settings, Applications, Personal access tokens

Push your code to the repository.

Any push under main or master triggers a release in production. Any push under another branch triggers a preview deployment in {branch-name}.{site-url}

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

malparty / netlify-deploy