Skip to content

Getting started

Nick Watts edited this page Oct 19, 2022 · 28 revisions
  1. We use Node.js 18 and Yarn. See https://nodejs.org/en/download/ for options for installing Node.js.
  2. Install "unplugged" dependencies.
yarn install
  1. Start development server, which will report any lint violations as well:
yarn start
  1. Open http://localhost:3000 in a browser.

Testing

Run unit tests with:

yarn test

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.
  • 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.
  • In an IDE other than IntelliJ (VS Code, etc): install the eslint plugin from your package manager, and there should be a command to fix issues at any time.
  • In IntelliJ:
    • Styles should be automatically applied by .editorconfig; make sure you've also turned on eslint.
    • In order to correctly format a file at any time, run the IntelliJ Reformat Code action, and then right-click in a window and click Fix ESLint Problems. You could also create an IntelliJ macro to do this for you as explained here, and map running of the macro to a keyboard shortcut for convenience.
Clone this wiki locally