Skip to content

improve the readme #485

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

Merged
merged 1 commit into from
Dec 5, 2019
Merged

improve the readme #485

merged 1 commit into from
Dec 5, 2019

Conversation

nmasse-itix
Copy link
Contributor

Motivation

I spent two afternoons to setup a working environment for the tutorial-web-app.

I initially started with the NodeJS version I had (12) but Yarn could not compile the dependencies (sorry I did not keep a copy of the error messages).

Then, I decided to install the minimal recommended version of NodeJS (8) but I had weird TLS issues that seems to be linked to old versions of NodeJS:

[start:server] Error: write EPROTO 140735890109312:error:1414D17A:SSL routines:tls12_check_peer_sigalg:wrong curve:../deps/openssl/openssl/ssl/t1_lib.c:1101:
[start:server] 
[start:server]     at WriteWrap.afterWrite [as oncomplete] (net.js:868:14)

I finally had to dig into the official container image to figure out that the NodeJS version used is 10.

So I installed NodeJS 10 using NVM as recommended.

I also had issues with binaries (nodemon, npm-run-all, etc.) used in packages.json but not listed as dependencies.

What

I detailed the installation in the README file to make sure a newcomer like me has the required instruction to succeed.

Why

I spent too much time trying to get it working.

How

I detailed every step.

Checklist:

  • Code has been tested locally by PR requester
  • Changes have been successfully verified by another team member

@dlabaj dlabaj merged commit 5330e51 into integr8ly:master Dec 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants