Fabric8 Planner

Overview

Fabric8 Planner is a task planner and the issue tracker front-end for openshift.io. It uses the Fabric8 Work Item Tracker as the back-end.

The Planner project provides a component library which is used by other applications to provide a task planning front-end.

The Planner is available as an npm package. It can not be run by itself as it is an Angular component library. However, for development and testing purpose, a minimal runtime environment is available in the runtime directory.

You can run Planner either as a minimal Standalone component or as an Integrated component using an external webapp like the fabric8-ui. It is recommended to use the Integrated component to build and run Planner.

Quickstart

The Planner can be quickly built using the launcher script.

You can use the launcher script to build the Planner either as an Integrated component using an external webapp like the fabric8-ui or as a Standalone component.

Integrated mode

Note	The Integrated mode is the default mode for building Planner using this script.

Prerequisite

• Ensure that Node.js (v8.3.0) and npm are installed in your system.

Procedure

1. To build and run the Planner with an integrated environment such as fabric8-ui (or an external web app) use:

   $ scripts/run-planner.sh

   This script supports the following flags:

   • Use -r - to re-install everything

   • Use -s - to start Planner in standalone mode using the runtime

   • Use -f - to set the path to Fabric8 UI directory (This requires path argument)

   • Use -p - to set the path to the Planner directory (This requires the path argument)

   For example:

   • Use scripts/run-planner.sh -r -s to re-install planner and run it in standalone mode.

   • Use scripts/run-planner.sh -r -f /home/User/fabric8-ui if you wish to set the platform path. By default, the Fabric8 UI path is assumed to be Planner_Path/..

2. Access the service on: http://localhost:3000

Standalone mode

The Standalone Mode uses prod-preview backend by default.

1. To build and run a standalone, minimal runtime implementation of the Planner using the prod-preview database use:

   $ scripts/run-planner.sh --standalone

   Or

   $ scripts/run-planner.sh -s

2. Access the service on http://localhost:8080

3. Get an auth token:

   1. Navigate to http://api.prod-preview.openshift.io/api/login/authorize?redirect=https://api.openshift.io/api/status

   2. Log in with your OSIO user name (for example, <username>+[email protected]). The part after "?token_json" in the resulting url is the token. Copy this token.

4. Use the token to log in as: localhost:8080/?<the token>

5. Navigate to prod-preview and get a space ID you want to use from the url.

6. Use that spaceId to get to a space on your local instance: http://localhost:8080/plan/list?q=(space:<spaceId>%20$AND%20typegroup.name:Scenarios)&showTree=true

Optionally, you can change the default prod-preview backend and use external web apps by setting the environment variables for the services, for example:

• To use Fabric8 wit as the backend use the environment variable: FABRIC8_WIT_API_URL

• To use Fabric8 Auth as the backend use the environment variable: FABRIC8_AUTH_API_URL

Documentation

The following documentation is available in the docs directory:

• Technology Stack: Lists the the technology stack used by Planner.

• Testing: Covers the tests you can run on Planner.

• Alternate ways to run Planner: Provides information about alternate methods to run Planner.

• Useful scripts and tasks: Provides a list of useful npm scripts managed by gulp tasks.

Contributing

All contributions are welcome, if you want to contribute to this project, ensure you follow the Contribution Guidelines.