kubeflow
/
notebooks
mirror of https://github.com/kubeflow/notebooks.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
notebooks/workspaces/frontend/README.md

2.5 KiB
Raw Blame History

Kubeflow Workspaces Frontend

The Kubeflow Workspaces Frontend is the web user interface used to monitor and manage Kubeflow Workspaces as part of Kubeflow Notebooks 2.0.

⚠️ Warning ⚠️

The Kubeflow Workspaces Frontend is a work in progress and is NOT currently ready for use. We greatly appreciate any contributions.

Dev Setup

Requirements

This project requires the following tools to be installed on your system:

  • NodeJS and NPM
    • Node recommended version -> 20.17.0
    • NPM recommended version -> 10.8.2

Development

  1. Clone the repository:

    git clone https://github.com/kubeflow/notebooks.git

  2. Checkout the Notebooks 2.0 development branch:

    git checkout notebooks-v2

  3. Navigate to the frontend directory and install the project dependencies.

    cd workspaces/frontend && npm install

Build the Project

npm run build

Serve the UI Locally

This is the default setup for running the UI locally. Make sure you build the project using the instructions above prior to running the command below.

npm run start:dev

The command above requires the backend to be active in order to serve data. To run the UI independently, without establishing a connection to the backend, use the following command to start the application with a mocked API:

npm run start:dev:mock

Testing

Run all tests:

npm run test

Linting

Check for linting issues:

npm run test:lint

Automatically fix linting issues:

npm run test:fix

API Types & Client Generation

The TypeScript types and the HTTP client layer for interacting with the backend APIs are automatically generated from the backend's swagger.json file. This ensures the frontend remains aligned with the backend API contract at all times.

Generated Code Location

All generated files live in the src/generated directory.

⚠️ Do not manually edit any files in this folder.

Updating the Generated Code

To update the generated code, first update the swagger.version file in the scripts directory to the desired commit hash of the backend's swagger.json file.

Then run the following command to update the generated code:

npm run generate:api

Finally, make any necessary adaptations based on the changes in the generated code.