Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add requisites to installation instructions #4730

Closed
JackNWhite opened this issue Jan 19, 2022 · 5 comments · Fixed by #4732
Closed

Add requisites to installation instructions #4730

JackNWhite opened this issue Jan 19, 2022 · 5 comments · Fixed by #4732
Labels
source:community Community contribution or request type:maintenance tests, chores, or project maintenance
Milestone

Comments

@JackNWhite
Copy link

Summary

Current instructions are:

  1. Clone the source code
    git clone https://github.com/nasa/openmct.git

  2. Install development Dependencies
    npm install

  3. Run a local development server
    npm start

My example npm install log is:

npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE   package: '[email protected]',
npm WARN EBADENGINE   required: { node: '>=10.12.2 <16.0.0' },
npm WARN EBADENGINE   current: { node: 'v17.4.0', npm: '8.3.1' }
npm WARN EBADENGINE }
npm WARN deprecated [email protected]: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
npm WARN deprecated [email protected]: this library is no longer supported
npm WARN deprecated [email protected]: Removed event-stream from gulp-header
npm WARN deprecated [email protected]: CoffeeScript on NPM has moved to "coffeescript" (no hyphen)
npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
npm WARN deprecated [email protected]: babel-eslint is now @babel/eslint-parser. This package will no longer receive updates.
npm WARN deprecated [email protected]: core-js@<3.4 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Please, upgrade your dependencies to the actual version of core-js.

> [email protected] prepare
> npm run build:prod


> [email protected] build:prod
> cross-env webpack --config webpack.prod.js

WARNING in asset size limit: The following asset(s) exceed the recommended size limit (244 KiB).
This can impact web performance.
Assets: 
  openmct.js (3.55 MiB)

WARNING in entrypoint size limit: The following entrypoint(s) combined asset size exceeds the recommended limit (244 KiB). This can impact web performance.
Entrypoints:
  openmct (3.55 MiB)
      openmct.js


WARNING in webpack performance recommendations: 
You can limit the size of your bundles by using import() or require.ensure to lazy load some parts of your application.
For more info visit https://webpack.js.org/guides/code-splitting/

webpack compiled with 3 warnings

In light of the above, and this issue, please add requisite software versions to the installation instructions.

@JackNWhite JackNWhite added the type:maintenance tests, chores, or project maintenance label Jan 19, 2022
@unlikelyzero unlikelyzero added the source:community Community contribution or request label Jan 19, 2022
@unlikelyzero
Copy link
Contributor

@JackNWhite would #4732 work?

@charlesh88
Copy link
Contributor

Testathon 1-24-22: cannot verify, no test instructions.

@unlikelyzero unlikelyzero added the needs:test instructions Missing testing notes label Jan 24, 2022
@unlikelyzero
Copy link
Contributor

Testing Instructions

Verify that main readme includes a blurb about supported node versions

@unlikelyzero unlikelyzero removed the needs:test instructions Missing testing notes label Jan 24, 2022
@khalidadil
Copy link
Contributor

Verified in Testathon on 01/24/22 - I see the text "Note: Check the package.json engine for our tested and supported node versions." in the README

@charlesh88
Copy link
Contributor

Testathon 1-24-22: verified fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
source:community Community contribution or request type:maintenance tests, chores, or project maintenance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants