Skip to content

Commit 9266284

Browse files
committed
doc(dashboard): updated centraldashboard-angular developer guidance
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]>
1 parent 4644658 commit 9266284

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

components/centraldashboard-angular/README.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ wip-placeholder
1515

1616
### Getting Started
1717

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`
1919

2020
### Backend
2121

@@ -25,16 +25,42 @@ Backend server side code resides in the [backend](./backend) directory. The serv
2525
```
2626
cd components/centraldashboard-angular/backend
2727
npm i
28-
npm run backend
28+
npm run build
29+
npm run serve
2930
```
3031

3132
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.
3233

34+
ℹ️ The server will also attempt to connect to the Kubernetes cluster as identified in `kubectl config current-context`
35+
3336
### Frontend
3437

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:
53+
```bash
54+
npm ls kubeflow
55+
[email protected] [...]/kubeflow/components/crud-web-apps/common/frontend/kubeflow-common-lib/dist/kubeflow
56+
└── (empty)
57+
```
58+
59+
Finally, the `frontend` component of `kubeflow/dashboard` can then be built and served using the following commands:
3560
```bash
3661
cd components/centraldashboard-angular/frontend
3762
npm i
63+
npm link kubeflow
3864
npm run serve
3965
```
4066

components/centraldashboard-angular/frontend/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
# dependencies
1111
/node_modules
12+
/.angular
1213

1314
# profiling files
1415
chrome-profiler-events*.json

0 commit comments

Comments
 (0)