From 20ec57160c7fe9b9ac9938f58f4992872212ac88 Mon Sep 17 00:00:00 2001 From: Julius Volz Date: Fri, 22 Nov 2019 14:55:32 +0100 Subject: [PATCH] React UI: Clarify VSCode usage requirements (#6357) Signed-off-by: Julius Volz --- web/ui/react-app/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/web/ui/react-app/README.md b/web/ui/react-app/README.md index 6a5877578..91092919f 100755 --- a/web/ui/react-app/README.md +++ b/web/ui/react-app/README.md @@ -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: