Skip to content

Commit 01dba8a

Browse files
authored
Improve portal README.md formatting and clarity (#22173)
improving the portal readme file Signed-off-by: rgcr <[email protected]>
1 parent 19f4958 commit 01dba8a

File tree

1 file changed

+42
-17
lines changed

1 file changed

+42
-17
lines changed

src/portal/README.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,50 @@
11
![Harbor UI](https://raw.githubusercontent.com/goharbor/website/master/docs/img/readme/harbor_logo.png)
22

3-
Harbor UI
4-
============
5-
This is the project based on Clarity and Angular to build Harbor UI.
3+
# Harbor UI
64

5+
This project is the web interface for [Harbor](https://goharbor.io), built using [Clarity Design System](https://clarity.design/) and Angular.
76

7+
## Getting Started
88

9-
Start
10-
============
11-
1. Use the specified Node version:
12-
Run the following command to use the Node version specified in the .nvmrc file:
13-
```bash
14-
nvm install # Install the Node version specified in .nvmrc (if not already installed)
9+
### 1. Use the correct Node version
10+
11+
To ensure compatibility with dependencies, use the Node version defined in `.nvmrc`.
12+
13+
```
14+
nvm install # Install the Node version from .nvmrc (if not already installed)
1515
nvm use # Switch to the specified Node version
1616
```
17-
This step helps avoid compatibility issues, especially with dependencies.
18-
2. npm install (should trigger 'npm postinstall')
19-
3. npm run postinstall (if not triggered, manually run this step)
20-
4. copy "proxy.config.mjs.temp" file to "proxy.config.mjs"
21-
`cp proxy.config.mjs.temp proxy.config.mjs`
22-
5. Modify "proxy.config.mjs" to specify a Harbor server. And you can specify the agent if you work behind a corporate proxy
23-
6. npm run start
24-
7. open your browser on https://localhost:4200
17+
18+
### 2. Install dependencies
19+
20+
```
21+
npm install
22+
```
23+
24+
> Note: `npm install` should automatically trigger the `postinstall` script.
25+
If `postinstall` scripts were not triggered, then run manually: `npm run postinstall`
26+
27+
28+
### 3. Copy the template proxy file
29+
30+
```
31+
cp proxy.config.mjs.temp proxy.config.mjs
32+
```
33+
34+
### 4. Configure the proxy
35+
36+
Edit `proxy.config.mjs` to specify the Harbor server.
37+
You can specify the agent if you work behind a corporate proxy.
38+
39+
### 5. Start the development server
40+
41+
```
42+
npm run start
43+
```
44+
45+
### 6. Open the application
46+
47+
Open your browser at https://localhost:4200
48+
49+
2550

0 commit comments

Comments
 (0)