notebooks/components/crud-web-apps/volumes
Tariq Hasan 4451765b12 chore: update node in crud-web-apps from 12 to 16 (kubeflow/kubeflow#7637)
* upgrade node from 12 to 16

Signed-off-by: tariq-hasan <mmtariquehsn@gmail.com>

* replace cypress with playwright for e2e tests in jupyter

Signed-off-by: tariq-hasan <mmtariquehsn@gmail.com>

* update base image for node

Signed-off-by: tariq-hasan <mmtariquehsn@gmail.com>

* update build scripts for tensorboard

Signed-off-by: tariq-hasan <mmtariquehsn@gmail.com>

* update build scripts for jupyter

Signed-off-by: tariq-hasan <mmtariquehsn@gmail.com>

---------

Signed-off-by: tariq-hasan <mmtariquehsn@gmail.com>
2024-11-26 17:15:52 +00:00
..
backend feat(crud-web-apps): Add Prometheus metrics (kubeflow/kubeflow#7634) 2024-09-05 12:01:15 +00:00
frontend chore: update node in crud-web-apps from 12 to 16 (kubeflow/kubeflow#7637) 2024-11-26 17:15:52 +00:00
manifests feat(crud-web-apps): Add Prometheus metrics (kubeflow/kubeflow#7634) 2024-09-05 12:01:15 +00:00
.gitignore
Dockerfile chore: update node in crud-web-apps from 12 to 16 (kubeflow/kubeflow#7637) 2024-11-26 17:15:52 +00:00
Makefile Adding changes to build multi arch images on pull_request for VWA. (kubeflow/kubeflow#7052) 2023-03-23 15:27:22 +00:00
README.md chore: update node in crud-web-apps from 12 to 16 (kubeflow/kubeflow#7637) 2024-11-26 17:15:52 +00:00

README.md

Volumes web app

This web app is responsible for allowing the user to manipulate PVCs in their Kubeflow cluster. To achieve this it provides a user friendly way to handle the lifecycle of PVC objects.

Development

Requirements:

  • node 16.20.2
  • python 3.8

Frontend

# build the common library
cd components/crud-web-apps/common/frontend/kubeflow-common-lib
npm i
npm run build
cd dist/kubeflow
npm link

# build the app frontend
cd ../../../volumes/frontend
npm i
npm link kubeflow
npm run build:watch

Backend

# create a virtual env and install deps
# https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
cd component/crud-web-apps/volumes/backend
python3.8 -m pip install --user virtualenv
python3.8 -m venv web-apps-dev
source web-apps-dev/bin/activate

# install the deps on the activated virtual env
make -C backend install-deps

# run the backend
make -C backend run-dev

internationalization

support for non-english languages is only supported in a best effort way.

internationalization(i18n) was implemented using angular's i18n guide and practices, in the frontend. you can use the following methods to ensure the text of the app will be localized:

  1. i18n attribute in html elements, if the node's text should be translated
  2. i18n-{attribute} in an html element, if the element's attribute should be translated
  3. $localize to mark text in typescript variables that should be translated

the file for the english text is located under i18n/messages.xlf and other languages under their respective locale folder, i.e. i18n/fr/messages.fr.xfl. each language's folder, aside from english, should have a distinct and up to date owners file that reflects the maintainers of that language.

testing

you can run a different translation of the app, locally, by running

ng serve --configuration=fr

you must also ensure that the backend is running, since angular's dev server will be proxying request to the backend at localhost:5000.