This project is a reference implementation for a modern React app. It is intended to be a starting point for a production application with reasonable defaults.
-
ESLint configuration suitable for production use.
-
CSS modules.
-
Modern JavaScript using Babel with Stage 2 features active.
-
Version-locked dependencies with lockfiles for predictability.
-
Integrated vulnerability scanning via snyk.
-
CircleCI 2.0 integration for lightning-fast builds.
-
Testing with Mocha/Chai/Enzyme/Sinon.
-
You first need to run
yarn installto install dependencies. -
You can run
yarn startto launch a development server for the app, accessible viahttp://localhost:8080. -
You can run
yarn buildto trigger a one-off build.- If
NODE_ENV=productionis set, then the build will be minified.
- If
-
Run
yarn run securityto scan dependencies for vulnerabilities.- Requires Snyk authentication and Internet access.
The index.html and index.css files in the root of this project are considered static. Core application code lives within the src directory. Within:
-
The app's entry point is index.js.
-
Core test setup code lives in spec.setup.js.
-
React components live within the components directory.
-
Individual React components live within their own directory, containing:
-
index.js The component itself.
-
styles.css The CSS module responsible for styling the component.
-
spec.js The tests for the component.
-
strings.js I18n strings for the component.
-
…and any other incidental files needed by the component.
-
-
A strings.js file should export a function with the signature t(key: string, ...more): string.
Components should not contain text directly. Instead, components should use this I18n helper to request text. For example:
// Bad. The string "Submit" is hard-coded.
<button>Submit</button>
// Good. The string comes from an I18n helper.
<button>{t('submit')}</Button>