From 2355552d8068a2e6c2cb94390c9249d02b78472a Mon Sep 17 00:00:00 2001
From: Leo <oliveiraleo@users.noreply.github.com>
Date: Sun, 3 Mar 2024 13:13:00 -0300
Subject: [PATCH] Update nodejs version on readme instructions (#71)

* Updates yarn's APT commands on readme

* Updates nodejs' version and tidy up some text formatting on readme

* Update Node.js to v20 LTS

Co-authored-by: Michael <michael.cs08@nycu.edu.tw>

* Update readme instructions to use yarn from Ubuntu repos

Co-authored-by: Michael <michael.cs08@nycu.edu.tw>

* Update readme instructions to not yarn setup from APT

Co-authored-by: Michael <michael.cs08@nycu.edu.tw>

* Update the comment regarding nodejs version check

* Update readme instructions with enhanced messages

* Add corepack command to readme
As suggested by @andy89923 in https://github.com/free5gc/webconsole/pull/71#discussion_r1496906993 corepack needs to be called to setup yarn
Later, yarn is used to build the webconsole module

* Remove yarn installation section from readme
Following the discussion on https://github.com/free5gc/webconsole/pull/71 and according to the comment https://github.com/free5gc/webconsole/pull/71#discussion_r1490360003 as yarn will be setup by corepack, there's no need to install it manually anymore

* Update corepack command on readme
It's necessary to give permission for corepack to install/edit binary files on system /usr/bin folder

---------

Co-authored-by: Michael <michael.cs08@nycu.edu.tw>
---
 readme.md | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/readme.md b/readme.md
index b6d236b..b34428d 100644
--- a/readme.md
+++ b/readme.md
@@ -1,23 +1,19 @@
 # free5GC Web Console
 
-### Install yarn:
-```bash
-sudo apt remove cmdtest yarn
-curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
-echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
-sudo apt-get update
-sudo apt-get install -y nodejs yarn
-```
-
 ### Install Node.js
 ```bash
 sudo apt remove nodejs -y
-curl -s https://deb.nodesource.com/setup_16.x | sudo bash
+curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt update
 sudo apt install nodejs -y
-node -v # check version is 16.x
+node -v # check that version is 20.x
+sudo corepack enable
 ```
 
-To run free5GC webconsole server. The following steps are to be considered.
+### Build the Server
+
+To be able to run free5gc's webconsole server, consider building its source through the following steps:
+
 ```bash
 # (In directory: ~/free5gc/webconsole)
 cd frontend
@@ -28,6 +24,9 @@ cp -R build ../public
 ```
 
 ### Run the Server
+
+To run free5gc's webconsole server, use:
+
 ```bash
 # (In directory: ~/free5gc/webconsole)
 go run server.go
@@ -35,7 +34,8 @@ go run server.go
 
 ### Connect to WebConsole
 
-Enter <WebConsole server's IP>:5000 in URL bar.
+Enter `<WebConsole server's IP>:5000` in an internet browser URL bar
 
-Username: admin
-Password: free5gc
+Then use the credentials below:
+- Username: admin
+- Password: free5gc
-- 
GitLab