From 1fd55b44d2c8de25129f0d5a81e3fe4bea7f8349 Mon Sep 17 00:00:00 2001 From: tsangington Date: Mon, 27 May 2024 21:37:58 +0000 Subject: [PATCH 1/7] UPD: Updated readme to include specific instructions for WSL and linux setup differences --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 87b0549..187e6df 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,37 @@ # Setup for code-idp as a developer: Prerequisites: - +- Node 18.20 +
+Installing Node 18.20 (using NVM) +To install node and npm in Ubuntu on WSL you need to install nvm. It doesn't work with apt-install. +Install NVM: +```sh +curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash +``` +Edit ~/.bashrc or ~/.zshrc depending on the Linux Shell you're using and add the following at the bottom. +```sh +export NVM_DIR="/home/yourusername/.nvm" [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" +``` +Restart your shell and docker after this step. +nvm install node version 18.20.3 +```sh +nvm install v18.20.3 +``` +
- [Yarn 1 "Classic"](https://classic.yarnpkg.com/lang/en/docs/install/) - [Docker Desktop](https://www.docker.com/products/docker-desktop/) +
+Installing Docker on WSL or Linux +For Linux, follow this [link](https://docs.docker.com/engine/install/ubuntu/) for Ubuntu Docker install. +
+ +For WSL, use this [link](https://docs.docker.com/desktop/wsl/) (do not install docker on the linux distro on WSL.) + +
+Notes: +
+ Clone the repository and install node_modules: ```sh From 2bee7f4d21e89b50d2922c4422a10f957cffab10 Mon Sep 17 00:00:00 2001 From: tsangington Date: Mon, 27 May 2024 21:40:22 +0000 Subject: [PATCH 2/7] UPD: Update Readme formatting --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 187e6df..b6e8220 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,33 @@ Prerequisites: - Node 18.20
Installing Node 18.20 (using NVM) +
To install node and npm in Ubuntu on WSL you need to install nvm. It doesn't work with apt-install. Install NVM: + ```sh curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash ``` + Edit ~/.bashrc or ~/.zshrc depending on the Linux Shell you're using and add the following at the bottom. + ```sh export NVM_DIR="/home/yourusername/.nvm" [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" ``` + Restart your shell and docker after this step. nvm install node version 18.20.3 + ```sh nvm install v18.20.3 ``` +
- [Yarn 1 "Classic"](https://classic.yarnpkg.com/lang/en/docs/install/) - [Docker Desktop](https://www.docker.com/products/docker-desktop/)
Installing Docker on WSL or Linux +
For Linux, follow this [link](https://docs.docker.com/engine/install/ubuntu/) for Ubuntu Docker install.
From ddddc37696607bddc906a10e3b5bded8565d289a Mon Sep 17 00:00:00 2001 From: tsangington Date: Mon, 27 May 2024 21:42:03 +0000 Subject: [PATCH 3/7] UPD: Update Readme more formatting --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b6e8220..934e9ad 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ Edit ~/.bashrc or ~/.zshrc depending on the Linux Shell you're using and add the export NVM_DIR="/home/yourusername/.nvm" [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" ``` -Restart your shell and docker after this step. +Restart your shell and docker after this step. +
nvm install node version 18.20.3 ```sh @@ -28,8 +29,10 @@ nvm install v18.20.3 ```
+ - [Yarn 1 "Classic"](https://classic.yarnpkg.com/lang/en/docs/install/) - [Docker Desktop](https://www.docker.com/products/docker-desktop/) +
Installing Docker on WSL or Linux
From fcfa23ee0569c39ed15afb59aef74b466a377117 Mon Sep 17 00:00:00 2001 From: tsangington Date: Mon, 27 May 2024 21:44:58 +0000 Subject: [PATCH 4/7] UPD: Update Readme more formatting 2 --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 934e9ad..f96ebff 100644 --- a/README.md +++ b/README.md @@ -142,8 +142,11 @@ To get you GitHub integration working you need to generate yourself a new token 2. Write a note (can be empty but encourged so you know what the tokens belongs to) 3. Set an expiration date (can be unlimited just be careful not to share it or you might have to revoke it manully) 4. Select a scope the following is enough for basic usage (may have to adjusted if you want to go beyong the basic scope) + img + 5. Copy and paste your `GitHub Token` and paste it into the correct environment variable (`GITHUB_TOKEN`) + 6. follow this guide in order to authorize your token: https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on # Running Environments From 0674f687a9d89c19cf31353b9744d50d097d5b3e Mon Sep 17 00:00:00 2001 From: tsangington Date: Mon, 27 May 2024 21:47:47 +0000 Subject: [PATCH 5/7] UPD: Update Readme more formatting 3 --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f96ebff..0fbabb1 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Prerequisites: Installing Node 18.20 (using NVM)
To install node and npm in Ubuntu on WSL you need to install nvm. It doesn't work with apt-install. +
Install NVM: ```sh @@ -36,10 +37,14 @@ nvm install v18.20.3
Installing Docker on WSL or Linux
-For Linux, follow this [link](https://docs.docker.com/engine/install/ubuntu/) for Ubuntu Docker install. + +For Linux, follow this [link](https://docs.docker.com/engine/install/ubuntu/) + +for Ubuntu Docker install.
-For WSL, use this [link](https://docs.docker.com/desktop/wsl/) (do not install docker on the linux distro on WSL.) +For WSL, use this [link](https://docs.docker.com/desktop/wsl/) +(do not install docker on the linux distro on WSL.)
Notes: From 4e7a744b519c136d6c14d4b338b8884d7da01ccc Mon Sep 17 00:00:00 2001 From: Harry Tsang <102903601+Tsangington@users.noreply.github.com> Date: Mon, 27 May 2024 23:54:04 +0200 Subject: [PATCH 6/7] UPD: Update README.md --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0fbabb1..3ad2915 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ # Setup for code-idp as a developer: Prerequisites: -- Node 18.20 +- Node 18.20.3
-Installing Node 18.20 (using NVM) +Installing Node 18.20.3 (using NVM)
To install node and npm in Ubuntu on WSL you need to install nvm. It doesn't work with apt-install.
@@ -28,6 +28,9 @@ nvm install node version 18.20.3 ```sh nvm install v18.20.3 ``` +Version of node and npm last working: +
+![image](https://github.com/codeuniversity/code-idp/assets/102903601/0dd022ba-dbc9-43b0-83aa-b1b5a1bb3ce7)
@@ -48,6 +51,17 @@ For WSL, use this [link](https://docs.docker.com/desktop/wsl/)
Notes: +Make sure that for the windows Docker engine that you have this option activated. +
+ +![image](https://github.com/codeuniversity/code-idp/assets/102903601/f04a2912-0365-4711-b69c-f4b56b6818a4) + +
+When Running "wsl.exe -l -v", make sure all versions are on WSL2. +
+ +![image](https://github.com/codeuniversity/code-idp/assets/102903601/b728d802-4aec-4771-b4d5-4ac88b9709f7) +
From aaabf142e07c72d75810e8629d0a6a1e6ac460fe Mon Sep 17 00:00:00 2001 From: Harry Tsang <102903601+Tsangington@users.noreply.github.com> Date: Mon, 27 May 2024 23:54:55 +0200 Subject: [PATCH 7/7] UPD: Update README.md 2 --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3ad2915..4a44ac8 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,9 @@ Version of node and npm last working:
![image](https://github.com/codeuniversity/code-idp/assets/102903601/0dd022ba-dbc9-43b0-83aa-b1b5a1bb3ce7) +
+Node version: 18.20.3 +NPM version: 10.7.0
- [Yarn 1 "Classic"](https://classic.yarnpkg.com/lang/en/docs/install/)