Skip to content

Latest commit

 

History

History
 
 

webapps

README.md

Camunda Webapp

This is the Camunda Platform web application source. Clean, package and install it via Maven.

Structure of this project

The structure is as follows:

  • ui - HTML, CSS and Javascript sources as well as Plugins and tests for the Camunda webapplications Cockpit, Tasklist and Admin.
  • src - Java sources and tests for the Camunda web application.

UI

There are 3 web applications available for the Camunda Platform :

  • cockpit: an administration interface for processes and decisions
  • tasklist: provides an interface to process user tasks
  • admin: is used to administer users, groups and their authorizations

The webapps above are relying on 2 libraries:

  • camunda-bpm-sdk-js: provides tools for developers who want interact with the platform using Javascript
  • camunda-commons-ui: is a set of shared scripts, templates and assets, used in the different webapps

Plugins

Parts of the web applications can be extended using plugins.

See plugin development guide for details.

Libraries

camunda-bpm-sdk-js

Has tools to work with the REST API and forms (included transitively via camunda-commons-ui).

camunda-commons-ui

Contains resources like images, .less stylesheets as well as some angular.js modules.

camunda-webapp-translations

Contains the translation files for all application texts in different languages.

Prerequisite

You need node.js and npm. You will also need to install grunt globally using npm install -g grunt-cli.

Setup

Adjusting Maven Settings

See https://github.com/camunda/camunda-bpm-platform/blob/master/CONTRIBUTING.md#build-from-source

Using Grunt

Installing the webapps is done by Grunt:

# cd <path to your workspace>
git clone git@github.com:camunda/camunda-bpm-platform.git
cd camunda-bpm-platform/webapps
npm install
grunt

To start the server in development mode, call

mvn jetty:run -Pdevelop

The webapps are then available pointing a browser at http://localhost:8080. To login as an admin user, use jonny1 as username and password.

You can now start developing using the grunt auto-build command in the webapp directory. To shorten compile times, you can specify the project you are going to make changes to by calling grunt auto-build:admin

If you are only changing Javascript files, you can set the environment variable FAST_BUILD to 1 to further improve compile times.

Testing

Install the webapps with Grunt and start the server in test mode:

mvn jetty:run -Pdev-e2e

Make sure that you terminate the server for development or use another port. You may configure the port the server runs on by passing the argument -Djetty.port=WHICH_PORT to the command line.

To run the tests, call

grunt test-e2e --protractorConfig=ui/common/tests/develop.conf.js

Now, it opens a new browser at http://localhost:8080 and does the test steps. If you want to test only one spec or a part of it then you can annotate the description of the spec with the keyword only:

describe.only('Cockpit Dashboard Spec', function() {
  // ...
}

AngularJS libraries from XLTS.dev

Since December 31, 2021, AngularJS is no longer officially supported by the original maintainers (Google). We replaced the official AngularJS libraries with the ones from XLTS.dev to ensure that our used libraries stay secure and supported. We include the AngularJS libraries from XLTS.dev in our Community Edition releases from 7.18.0-alpha2 on.

Heads-up: If you build the Webapps from source code, the build includes the no longer maintained AngularJS libraries in version 1.8.2 unless you have access to the XLTS.dev registry and configure it as shown below.

To enable pulling the XLTS.dev AngularJS libraries while building the Webapps, please configure the npm registry. Add the XLTS.dev npm registry by replacing the variables ${XLTS_REGISTRY} and ${XLTS_AUTH_TOKEN} in the following commands and execute the commands in your terminal.

Commands to configure the XLTS.dev npm registry:

npm set @xlts.dev:registry https://${XLTS_REGISTRY}/
npm set //${XLTS_REGISTRY}/:_authToken ${XLTS_AUTH_TOKEN}

Alternatively, you can set the following environment variables:

export XLTS_REGISTRY = "example.com" # Hostname without protocol (e.g., "https://"), leading or trailing slashes
export XLTS_AUTH_TOKEN = "abc..."    # Token to authenticate against the registry

You receive the information about the registry and the auth token directly from XLTS.dev.

Browsers support

The supported browsers are:

  • Chrome Latest
  • Firefox Latest
  • Edge Latest

Contributing

Have a look at our contribution guide for how to contribute to this repository.

Help and support

License

The source files in this repository are made available under the Apache License Version 2.0.