Git Product home page Git Product logo

wipp-frontend's Introduction

WIPP Frontend

The main WIPP UI application, for uploading images, creating image processing workflows and much more.
Developped in Angular 7.

Install dependencies

Run npm ci to install dependencies using versions locked in package-lock.json for reproducibility.

Development setup

Configuration

A configuration file defining links between the WIPP-frontend and other tools must be placed at src/assets/config/config.json.
The following properties are expected to be defined in this file:

  • argoUiBaseUrl: URL of the Argo Workflows Dashboard, for workflow execution monitoring,
  • tensorboardUrl: URL of TensorBoard, for TensorFlow jobs monitoring,
  • jupyterNotebooksUrl: URL of JupyterHub, for Jupyter Notebooks,
  • plotsUiUrl: URL of Plots app for scatterplots visualization.

We provide a sample configuration file sample-config.json at the root of this repository defining a default configuration for the Argo Dashboard URL at localhost:30501 (sample argo-ui service patch to achieve this configuration available here).
This sample configuration file assumes that the other tools are not deployed and will redirect to "Page not found" in a development setup.

Please refer to the main WIPP repository to learn more about external tools configuration for WIPP.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

API root URL in development mode

Modify the environment property apiRootUrl in the environment.ts file from apiRootUrl: 'http://localhost:8080/api' to apiRootUrl: 'http://*IP_ADDRESS*:8080/api' (*IP_ADDRESS* being the IP address of your machine).

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

WIPP Development flow

We are following the Gitflow branching model for the WIPP development.

Contributing

Please follow the Contributing guidelines

Disclaimer

NIST Disclaimer

wipp-frontend's People

Contributors

mylenesimon avatar samiasa avatar sunnielyu avatar ktaletsk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.