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.
Running the Planner
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. So you can run Planner either as a minimal Standalone component or as an Integrated component using an external webapp like the fabric8-ui. Typically, you would want to develop in the Standalone mode and test your changes in the Integrated mode.
Quickstart
The Planner build can be quickly run using the launcher script.
You can use the launcher script to run the Planner either as a Standalone component or as an Integrated component using an external webapp like the fabric8-ui.
-
Without Docker: To run a minimal runtime implementation of the Planner using an in-memory mock database use:
$ scripts/run-planner.sh --standalone
You can access the service on
localhost:8080NoteTo run the script on macOS, install gnu-getopt, runbrew install gnu-getopt, and set it in your PATH:echo 'export PATH="/usr/local/opt/gnu-getopt/bin:$PATH"' >> ~/.zshrc. -
With Docker: To run the complete Planner stack using
Docker Composewith core, auth and their respective database setups use:docker-compose up
For detailed information on building and running Planner see Building the Planner Component Library documentation.
Useful Scripts and Tasks
The Planner delegates task running to gulp and allows parametric subtasks in the format of npm run <task> -- --subtask which translates into gulp <task> --subtask which is then can be executed.
The scripts section of the package.json file lists the main tasks i.e. build, clean & test. Following table lists the available npm scripts managed with gulp tasks, but to understand the routines triggered by the subtask parameters, please check out the gulpfile:
| Task | Subtask | Command | Description |
|---|---|---|---|
Build |
[default] app |
|
Builds the planner library |
image |
|
Creates container image for the app |
|
release |
|
Publishes the library to |
|
tarball |
|
Packs the library into a tarball |
|
validate |
|
Dry runs the build for validation |
|
watch |
|
Rebuilds planner library on file changes |
|
Clean |
[default] all |
|
Fully resets the project |
cache |
|
Clears |
|
config |
|
Resets app config & env_vars |
|
dist |
|
Removes the build artifacts |
|
images |
|
Stops containers & removes the images |
|
modules |
|
Removes all |
|
temp |
|
Removes temp files and artifacts |
|
Tests |
unit |
|
Runs the unit tests |
func |
|
Runs the functional tests |
|
smok |
|
Runs the smoke tests |
|
Commands with strikethroughs aren’t yet implemented. |
|||
Documentation
The following documentation is available in the docs directory:
-
Building the Planner: Provides information on manually building the Planner in Standalone, Integrated, and Production environments.
-
Technology Stack: Lists the the technology stack used by Planner.
-
Testing: Covers the tests you can run on Planner.
Contributing
All contributions are welcome, if you want to contribute to this project, ensure you follow the Contribution Guidelines.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent