notebooks/components/crud-web-apps/volumes
dependabot[bot] 353f7a0fc7 build(deps): bump minimist from 1.2.5 to 1.2.6 in /components/crud-web-apps/volumes/frontend (kubeflow/kubeflow#6423)
Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-04-14 09:21:53 +00:00
..
backend fix(web-apps): Use Angular's i18n proposed implementation (kubeflow/kubeflow#6065) 2021-08-12 05:13:03 -07:00
frontend build(deps): bump minimist from 1.2.5 to 1.2.6 in /components/crud-web-apps/volumes/frontend (kubeflow/kubeflow#6423) 2022-04-14 09:21:53 +00:00
manifests added env for app secure cookies (kubeflow/kubeflow#6395) 2022-03-29 19:43:22 +00:00
.gitignore Volumes Management UI (kubeflow/kubeflow#5684) 2021-03-18 01:07:16 -07:00
Dockerfile Don't use asterisk in Dockerfiles (kubeflow/kubeflow#6318) 2022-01-26 21:52:10 +00:00
Makefile Add CI format checks for the Volumes web app (kubeflow/kubeflow#5820) 2021-05-17 08:25:31 -07:00
README.md fix(web-apps): Use Angular's i18n proposed implementation (kubeflow/kubeflow#6065) 2021-08-12 05:13:03 -07: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 12.0.0
  • python 3.7

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.7 -m pip install --user virtualenv
python3.7 -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.