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
Updates `centraldashboard-angular` `README.md` for better guidance following the split into `kubeflow/dashboard` from `kubeflow/kubeflow`.
Also adds a `.gitignore` entry for `.angular` - as following the local development guidance results in an `.angular/cache` directory we don't want in source control.
Signed-off-by: Andy Stoneberg <[email protected]>
Copy file name to clipboardExpand all lines: components/centraldashboard-angular/README.md
+28-2
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ wip-placeholder
15
15
16
16
### Getting Started
17
17
18
-
Make sure you have and use the proper version of `node` installed along with `npm` for this component (See Dockerfile). First, clone the repository and change directories to `components/centraldashboard`
18
+
Make sure you have and use the proper version of `node` installed along with `npm` for this component (See Dockerfile). First, clone the repository and change directories to `components/centraldashboard-angular`
19
19
20
20
### Backend
21
21
@@ -25,16 +25,42 @@ Backend server side code resides in the [backend](./backend) directory. The serv
25
25
```
26
26
cd components/centraldashboard-angular/backend
27
27
npm i
28
-
npm run backend
28
+
npm run build
29
+
npm run serve
29
30
```
30
31
31
32
This starts the Express API server at http://localhost:8082. Requests from the front-end starting with `/api` are proxied to the Express server. All other requests are handled by the front-end server which mirrors the production configuration.
32
33
34
+
ℹ️ The server will also attempt to connect to the Kubernetes cluster as identified in `kubectl config current-context`
35
+
33
36
### Frontend
34
37
38
+
With the re-organization of `kubeflow/dashboard` from `kubeflow/kubeflow` - the `frontend` component current still requires dependencies from `kubeflow-common-lib` package of `kubeflow/kubeflow``crud-web-apps` component.
39
+
40
+
In order to run `centraldashboard-angular` - one still must clone [`kubeflow/kubeflow`](https://github.com/kubeflow/kubeflow) and perform the following:
41
+
42
+
```bash
43
+
cd components/crud-web-apps/common/frontend/kubeflow-common-lib
44
+
npm i
45
+
npm run build
46
+
cd dist/kubeflow
47
+
npm link
48
+
```
49
+
- ⚠️ Details on [building for local development](https://github.com/kubeflow/kubeflow/blob/master/components/crud-web-apps/common/frontend/kubeflow-common-lib/README.md#building-the-library-locally)
50
+
- Ensure `node -v` aligns with the version of NodeJS as specified in the [`Dockerfile`](./Dockerfile)
51
+
52
+
Once the `kubeflow-common-lib` is built and linked successfully, you should be able to verify via the following:
0 commit comments