You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-20Lines changed: 52 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,44 +2,72 @@
2
2
3
3
# ui-frontend
4
4
5
-
## About this project
5
+
## About This Project
6
6
7
7
This repository contains code relevant for the frontend component required in the Managed Control Plane UI (MCP UI), which is part of the @openmcp-project, more info [here](https://github.com/openmcp-project).
8
8
9
9
The MCP UI enables endusers to work with Managed Control Planes, without having to use kubectl. Note that the current focus of the UI is on displaying information about the various managed resources, as well as the MCP instances themselves. It is also possible to check the status of the resources, and display / copy their YAML representations.
10
10
11
11
Overall, the UI provides an easy jump-start for everyone interested in checking the status of Managed Control Planes, without having to use kubectl.
12
12
13
-
## Requirements and Setup
13
+
## Getting Started
14
14
15
-
### Development
15
+
### Development Setup
16
16
17
-
1. install dependencies: `npm i`
17
+
#### Install Dependencies
18
18
19
-
1. Copy the `frontend-config.json` to `public/frontend-config.json` and adapt the `backendUrl` according to your setup (see section Dynamic Frontend Config).
19
+
```bash
20
+
npm i
21
+
```
22
+
23
+
#### Configure Frontend
24
+
25
+
- Copy `frontend-config.json` to `public/frontend-config.json` and adapt the `backendUrl` according to your setup (see section Dynamic Frontend Config).
26
+
- Copy `.env.template` to `.env` and fill in the missing values.
20
27
21
-
1. Connect to the ui-backend server
22
-
**Run it locally**:
23
-
- See `https://github.com/openmcp-project/ui-backend`
28
+
#### Run the Application
29
+
30
+
```bash
31
+
npm run dev
32
+
```
24
33
25
-
1. Start the application:
34
+
The UI will be served on http://localhost:5173.
26
35
27
-
Run `npm run dev`
28
36
29
-
###Build
37
+
#### Safari Support
30
38
31
-
1. Build the application:
39
+
**Note:** The frontend is currently incompatible with Safari when running locally on `localhost`.
32
40
33
-
Run `npm run build`
41
+
To enable local development with Safari, follow these steps on your local machine:
34
42
35
-
2. Serve the application locally:
43
+
1.**Update Cookie Settings:**
44
+
In [`server/encrypted-session.js`](server/encrypted-session.js), set the `secure` property to `false` in both occurrences.
36
45
37
-
Run `npm run preview`
46
+
2.**Disable Helmet Registration:**
47
+
In [`server.js`](server.js), comment out or remove the registration of `helmet`.
38
48
39
-
3. For production:
40
49
41
-
Use the docker image which uses nginx for best performance and small bundle size.
42
-
`docker build -t my-label .`
50
+
### Build & Production
51
+
52
+
#### Build the Application
53
+
54
+
```bash
55
+
npm run build
56
+
```
57
+
58
+
#### Serve the Production Build Locally
59
+
60
+
```bash
61
+
npm run preview
62
+
```
63
+
64
+
#### Production Deployment
65
+
66
+
Use the docker image which uses nginx for best performance and small bundle size.
67
+
68
+
```bash
69
+
docker build -t my-label .
70
+
```
43
71
44
72
### Dynamic FrontendConfig
45
73
@@ -50,11 +78,11 @@ An example docker run command would be
50
78
docker run -p 5001:80 -e BACKEND_CONFIG="$(cat frontend-config.json)" -t ui-test
51
79
```
52
80
53
-
## Support, Feedback, Contributing
81
+
## Support & Contributing
54
82
55
83
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/openmcp-project/ui-frontend/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
56
84
57
-
## Security / Disclosure
85
+
## Security & Disclosure
58
86
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/openmcp-project/ui-frontend/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
59
87
60
88
## Code of Conduct
@@ -64,3 +92,7 @@ We as members, contributors, and leaders pledge to make participation in our com
64
92
## Licensing
65
93
66
94
Copyright 2025 SAP SE or an SAP affiliate company and ui-frontend contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/openmcp-project/ui-frontend).
0 commit comments