Skip to content

Commit

Permalink
React UI: Clarify VSCode usage requirements (prometheus#6357)
Browse files Browse the repository at this point in the history
Signed-off-by: Julius Volz <julius.volz@gmail.com>
  • Loading branch information
juliusv committed Nov 22, 2019
1 parent ac3932e commit 20ec571
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions web/ui/react-app/README.md
Expand Up @@ -16,6 +16,8 @@ To work with the React UI code, you will need to have the following tools instal
* The [Yarn](https://yarnpkg.com/) package manager.
* *Recommended:* An editor with TypeScript, React, and [ESLint](https://eslint.org/) linting support. See e.g. [Create React App's editor setup instructions](https://create-react-app.dev/docs/setting-up-your-editor/). If you are not sure which editor to use, we recommend using [Visual Studio Code](https://code.visualstudio.com/docs/languages/typescript). Make sure that [the editor uses the project's TypeScript version rather than its own](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript).

**NOTE**: When using Visual Studio Code, be sure to open the `web/ui/react-app` directory in the editor instead of the root of the repository. This way, the right ESLint and TypeScript configuration will be picked up from the React workspace.

## Installing npm dependencies

The React UI depends on a large number of [npm](https://www.npmjs.com/) packages. These are not checked in, so you will need to download and install them locally via the Yarn package manager:
Expand Down

0 comments on commit 20ec571

Please sign in to comment.