Dispatch Application

GitHub Repository |
npmjs package |
Unpkg CDN |
Dispatch Bundle


This is an application for managing postal/electronic deliveries which get forwarded to an external "Dual Delivery" service provider.

Prerequisites

- You need the API server running
- You need the DBP Dispatch Bundle

Local development

``bash


get the source

git clone git@github.com:digital-blueprint/dispatch-app.git
cd dispatch-app
git submodule update --init

install dependencies

npm install

constantly build dist/bundle.js and run a local web-server on port 8001

npm run watch

constantly build dist/bundle.js and run a local web-server on port 8001 using a custom assets directory assets_custom/

npm run watch-custom

run tests

npm test
`

Jump to , and you should get a Single Sign On login page.

By default, the application is built using the assets in assets/. However, custom assets can also be used to build the application. The custom assets can be added to the directory assets_custom/dbp-dispatch/assets/. This allows developers to easily develop and build the application for different environments.

To use the Nextcloud functionality you need a running Nextcloud server with the
webapppassword Nextcloud app like this
Nextcloud Development Environment.

Use app via Docker

$3

`yaml
version: '3'
services:
web:
image: ghcr.io/digital-blueprint/dispatch-app:latest
restart: always
ports:
- '8000:80'
`

Using this app as pre-built package

$3

If you want to install the dbp dispatch app in a new folder dispatch-app with a path prefix / you can call:

`bash
npx @digital-blueprint/cli@latest install-app dispatch dispatch-app /
`

Afterward you can point your Apache web-server to dispatch-app/public.

Make sure you are allowing .htaccess files in your Apache configuration.

Also make sure to add all of your resources you are using (like your API and Keycloak servers) to the
Content-Security-Policy in your dispatch-app/public/.htaccess, so the browser allows access to those sites.

You can also use this app directly from the Unpkg CDN
for example like this: dbp-dispatch/index.html

Note that you will need a Keycloak server along with a client id for the domain you are running this html on.

$3

If you want to update the dbp dispatch app in the current folder you can call:

`bash
npx @digital-blueprint/cli@latest update-app dispatch
`

Using a single activity as pre-built package

You can also use a single activity directly from the Unpkg CDN
for example the dbp-qualified-dispatch-pdf-upload activity to qualifiedly sign PDF documents like this:
dbp-qualified-dispatch-pdf-upload/index.html

Note that you will need a Keycloak server along with a client id for the domain you are running this html on.

Activities

This app has the following activities:

- dbp-dd-activity
- dbp-qualified-signature-pdf-upload
- dbp-official-signature-pdf-upload

You can find the documentation of these activities in the qualified dispatch activities documentation.

Adapt app

$3

You can add multiple attributes to the tag.

| attribute name | value | Link to description |
| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| provider-root | Boolean | app-shell |
| lang | String | language-select |
| entry-point-url | String | app-shell |
| keycloak-config | Object | app-shell |
| base-path | String | app-shell |
| src | String | app-shell |
| html-overrides | String | common |
| themes | Array | theme-switcher |
| darkModeThemeOverride | String | theme-switcher |

#### Mandatory attributes

If you are not using the provider-root attribute to "terminate" all provider attributes
you need to manually add these attributes so that the topic will work properly:

`html
auth
requested-login-status
analytics-event
initial-file-handling-state
clipboard-files>
``

$3

For frontend design customizations, such as logo, colors, font, favicon, and more, take a look at the theming documentation.

"dbp-dispatch" slots

These are common slots for the app-shell. You can find the documentation of these slots in the app-shell documentation.
For the app specific slots take a look at the dispatch activities.