/widget-bootstrap

This project is meant to be the starting point for widget development in the codeBeamer ALM system.

Primary LanguageJava

CodeBeamer widget development bootstrap project

This project is meant to be the starting point for widget development in the codeBeamer ALM system.

Requirements

Building the API client SDK requires:

  1. Java 1.8+
  2. Gradle
  3. Locally installed codeBeamer instance

Installation

Clone the project into your local repository.

To include the proper codeBeamer Java API, open the /build.gradle file in the repository and modify the codeBeamerInstallDir definition to the root path of your codeBeamer instance:

def codeBeamerInstallDir = '{codeBeamer installation directory}'

Getting started

After the installation you will be able to build a basic widget:

./gradlew clean build

To deploy the widget you can use the following command:

./gradlew deploy

It will copy the newly built jar into local codeBeamer installation.

To enable the newly deployed widget you'll need to restart the codeBeamer instance.

Now you should be able to see your newly created widget on the Add Widget view: Hello World widget

Misc

If you used the linux installer for your codeBeamer instance creation you can use the following commands to stop and start the system:

./gradlew stopCBLinux
./gradlew startCBLinux