notebooks/components/crud-web-apps/common/frontend/kubeflow-common-lib
Kimonas Sotirchos 5eb884bb3d web-apps(front): Update the README (kubeflow/kubeflow#5481)
* web-apps(front): Update the README

Update the readme with detailed commands on how to consume the library
as well as developer guidelines.

Signed-off-by: Kimonas Sotirchos <kimwnasptd@arrikto.com>

* web-apps(front): Fix typo in README

Signed-off-by: Kimonas Sotirchos <kimwnasptd@arrikto.com>
2020-12-23 02:42:28 -08:00
..
projects/kubeflow web-apps(front): Update the common frontend library (kubeflow/kubeflow#5463) 2020-12-21 05:06:25 -08:00
.editorconfig Create an Angular Library with common frontend code (kubeflow/kubeflow#5252) 2020-08-28 05:14:53 -07:00
.gitignore Create an Angular Library with common frontend code (kubeflow/kubeflow#5252) 2020-08-28 05:14:53 -07:00
README.md web-apps(front): Update the README (kubeflow/kubeflow#5481) 2020-12-23 02:42:28 -08:00
angular.json Create an Angular Library with common frontend code (kubeflow/kubeflow#5252) 2020-08-28 05:14:53 -07:00
package-lock.json web-apps(front): Update the common frontend library (kubeflow/kubeflow#5463) 2020-12-21 05:06:25 -08:00
package.json web-apps(front): Update the common frontend library (kubeflow/kubeflow#5463) 2020-12-21 05:06:25 -08:00
tsconfig.json Create an Angular Library with common frontend code (kubeflow/kubeflow#5252) 2020-08-28 05:14:53 -07:00
tslint.json Create an Angular Library with common frontend code (kubeflow/kubeflow#5252) 2020-08-28 05:14:53 -07:00

README.md

Kubeflow Common Frontend Library

This code provides a common library of reusable Angular Components that can be used from our different Kubeflow web apps. This library aims to:

  • Enforce a common UX throughout the different apps
  • Reduce the development effort required to propagate changes to all the web apps
  • Minimize the code duplication between our Kubeflow web apps

This project was generated with Angular CLI version 8.3.20, which is required to build and run the unit tests.

Local development

In order to use this library while developing locally your Angular app you will need to:

  1. Build the kubeflow node module from this source code
  2. Link the produced module to your global npm modules
  3. Link the kubeflow module in the npm modules of you app

Building the library locally

# build the npm module
npm run build

# might need sudo, depending on where you global folder lives
# https://nodejs.dev/learn/where-does-npm-install-the-packages
npm link dist/kubeflow

Linking it to the app

cd ${APP_DIR}
npm install
npm link kubeflow

Running unit tests

Run ng test to execute the unit tests via Karma.

Contributor Guidelines

Unit tests

  1. Any new component added to this library should also include some basic unit tests
  2. The unit tests should be passing at any point of time

Git commits

Git commits that modify this code should be prefixed with web-apps(front).