Skip to content

Commit

Permalink
feat(tooling): adds nvm (#6938)
Browse files Browse the repository at this point in the history
* 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 <john.c.hill@nasa.gov>
  • Loading branch information
evenstensberg and unlikelyzero committed Aug 19, 2023
1 parent a495e86 commit a52577e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit a52577e

Please sign in to comment.