|
3 | 3 | # Setup for code-idp as a developer: |
4 | 4 |
|
5 | 5 | Prerequisites: |
| 6 | +- Node 18.20.3 |
| 7 | +<details> |
| 8 | +<summary>Installing Node 18.20.3 (using NVM)</summary> |
| 9 | +<br> |
| 10 | +To install node and npm in Ubuntu on WSL you need to install nvm. It doesn't work with apt-install. |
| 11 | +<br> |
| 12 | +Install NVM: |
| 13 | + |
| 14 | +```sh |
| 15 | +curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash |
| 16 | +``` |
| 17 | + |
| 18 | +Edit ~/.bashrc or ~/.zshrc depending on the Linux Shell you're using and add the following at the bottom. |
| 19 | + |
| 20 | +```sh |
| 21 | +export NVM_DIR="/home/yourusername/.nvm" [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" |
| 22 | +``` |
| 23 | + |
| 24 | +Restart your shell and docker after this step. |
| 25 | +<br> |
| 26 | +nvm install node version 18.20.3 |
| 27 | + |
| 28 | +```sh |
| 29 | +nvm install v18.20.3 |
| 30 | +``` |
| 31 | +Version of node and npm last working: |
| 32 | +<br> |
| 33 | + |
| 34 | + |
| 35 | +<br> |
| 36 | +Node version: 18.20.3 |
| 37 | +NPM version: 10.7.0 |
| 38 | +</details> |
6 | 39 |
|
7 | 40 | - [Yarn 1 "Classic"](https://classic.yarnpkg.com/lang/en/docs/install/) |
8 | 41 | - [Docker Desktop](https://www.docker.com/products/docker-desktop/) |
9 | 42 |
|
| 43 | +<details> |
| 44 | +<summary>Installing Docker on WSL or Linux</summary> |
| 45 | +<br> |
| 46 | + |
| 47 | +For Linux, follow this [link](https://docs.docker.com/engine/install/ubuntu/) |
| 48 | + |
| 49 | +for Ubuntu Docker install. |
| 50 | +<br> |
| 51 | + |
| 52 | +For WSL, use this [link](https://docs.docker.com/desktop/wsl/) |
| 53 | +(do not install docker on the linux distro on WSL.) |
| 54 | + |
| 55 | +<br> |
| 56 | +Notes: |
| 57 | +Make sure that for the windows Docker engine that you have this option activated. |
| 58 | +<br> |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +<br> |
| 63 | +When Running "wsl.exe -l -v", make sure all versions are on WSL2. |
| 64 | +<br> |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | +</details> |
| 69 | + |
| 70 | + |
10 | 71 | Clone the repository and install node_modules: |
11 | 72 | ```sh |
12 | 73 | git clone https://github.com/codeuniversity/code-idp |
@@ -103,8 +164,11 @@ To get you GitHub integration working you need to generate yourself a new token |
103 | 164 | 2. Write a note (can be empty but encourged so you know what the tokens belongs to) |
104 | 165 | 3. Set an expiration date (can be unlimited just be careful not to share it or you might have to revoke it manully) |
105 | 166 | 4. Select a scope the following is enough for basic usage (may have to adjusted if you want to go beyong the basic scope) |
| 167 | + |
106 | 168 | <img height="400" alt="img" src="./images/githubintegration.svg"> |
| 169 | + |
107 | 170 | 5. Copy and paste your `GitHub Token` and paste it into the correct environment variable (`GITHUB_TOKEN`) |
| 171 | + |
108 | 172 | 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 |
109 | 173 |
|
110 | 174 | # Running Environments |
|
0 commit comments