From a52577e7296fda747912caeabe465805004d3023 Mon Sep 17 00:00:00 2001 From: Even Stensberg Date: Sat, 19 Aug 2023 22:16:26 +0200 Subject: [PATCH] feat(tooling): adds nvm (#6938) * feat(tooling): adds nvm * fix(ci): nodev16 -> nodev18 * chore(node): dont modify ci config * feat(nvm): add lts * docs(readme): add section on nvm * fix(docs): revise section --------- Co-authored-by: John Hill --- .nvmrc | 1 + README.md | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 .nvmrc diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000000..1a2f5bd204 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +lts/* \ No newline at end of file diff --git a/README.md b/README.md index 109aa43c49..1221e19a62 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,12 @@ Building and running Open MCT in your local dev environment is very easy. Be sur `git clone https://github.com/nasa/openmct.git` -2. Install development dependencies. Note: Check the package.json engine for our tested and supported node versions. +2. (Optionally) Install the correct node version using [nvm](https://github.com/nvm-sh/nvm) (`nvm install`) +3. Install development dependencies. Note: Check the package.json engine for our tested and supported node versions. `npm install` -3. Run a local development server +4. Run a local development server `npm start` @@ -51,6 +52,8 @@ For more on developing with Open MCT, see our documentation for a guide on [Deve This is a fast moving project and we do our best to test and support the widest possible range of browsers, operating systems, and nodejs APIs. We have a published list of support available in our package.json's `browserslist` key. +The project uses `nvm` to ensure the node and npm version used, is coherent in all projects. Install nvm (non-windows), [here](https://github.com/nvm-sh/nvm) or the windows equivalent [here](https://github.com/coreybutler/nvm-windows) + If you encounter an issue with a particular browser, OS, or nodejs API, please file a [GitHub issue](https://github.com/nasa/openmct/issues/new/choose) ## Plugins