Getting started

Initial setup

Configure git to ignore some commits (containing large formatting changes) in git blame.

git config blame.ignoreRevsFile /path/to/terra-ui/.git-blame-ignore-revs

Running Terra UI

1. Install Node.js 18 and Yarn. See https://nodejs.org/en/download/ for options for installing Node.js.

2. Install "unplugged" dependencies.

   yarn install

   Terra UI uses yarn's "Plug'n'Play", so most dependencies are checked into git in .yarn/cache. "Unplugged" dependencies are those with native components.

3. Start development server.

   yarn start

4. Open http://localhost:3000 in a browser.

Testing

Run unit tests with:

yarn test

By default, tests that write console logs will fail. To avoid this while debugging, use ALLOW_LOGS=true yarn test.

More information on unit tests

Code style and linting

ESLint is automatically run on commits via a pre-commit hook. To skip the pre-commit hook, use git commit --no-verify.

ESLint runs Prettier to format code. You may want to configure your editor to format on save.

To attempt to automatically resolve lint issues, run yarn lint from the repo's root directory. ESLint will fix whatever issues it can and report any that must be manually resolved. Consider configuring your editor to show lint warnings so they can be resolved during development.