denbicloud/cloud-portal-webapp repository overview

⁠Cloud Portal Web App

This app provides access to the Portal-API and to the Perun API.

⁠Production

⁠Run

You can run the webapp using docker:

docker run -e ANGULAR_MODE=prod -p 80:80 denbicloud/cloud-portal-webapp:RELEASE

You can find current releases on GitHub.

Note: The cloud-api server must also be running.

⁠Development

⁠Project Setup

1. Clone the cloud-portal-webapp repository.

git clone -b dev https://github.com/deNBI/cloud-portal-webapp.git
cd cloud-portal-webapp

1. Install nodejs virtual environment as decribed here⁠.

2. Run the Makefile

make

The default target checks if steps 1 - 3 were executed and then creates a node-environment, followed by installing all needed npm packages and angular cli (by running npm install and npm install -g @angular/cli). For more makefile targets run help.

make help

1. Start the angular server with make or by yourself

make serve

or

. env/bin/activate
ng serve

the dev server should run now on localhost:8001. The app will automatically reload if you update any of the source files.

⁠Debug with Intellij

⁠1.Setup

You must first setup and start the project as described in the Project Setup section.

⁠2.Enable Javascript debugging

Enable Javascript debugging by choosing JavaScript Debug in your Run/Debug configurations

⁠3. Once you start the Debug mode a browser window should pop up.

⁠Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

⁠Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class/module.

⁠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⁠. Before running the tests make sure you are serving the app via ng serve.

⁠Further help

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

⁠Documentation

We are using Compodoc⁠ to visualize the code written in TypeScript-files.

⁠Installation

• You can install Compodoc with npm:

npm install

⁠Usage

• Comment your code written in TypeScript-files. Comment-syntax is equivalent to Javascript.

Example:

  /**
   * Uses the data from the application form to fill the confirmation-modal with information.
   * @param f the application form with corresponding data
   */
  filterEnteredData(f: NgForm) {
  ...

• Use the following commands to let Compodoc analyze the written code and comments.

npm run compodoc

• To view the created documentation, use your favorite webbrowser (e.g. firefox)

firefox documentation/overview.html