Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digital-blueprint/dispatch-app
Dispatch Application
https://github.com/digital-blueprint/dispatch-app
dbp digital-blueprint dispatch
Last synced: about 2 months ago
JSON representation
Dispatch Application
- Host: GitHub
- URL: https://github.com/digital-blueprint/dispatch-app
- Owner: digital-blueprint
- License: lgpl-2.1
- Created: 2023-01-20T11:26:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T11:41:00.000Z (9 months ago)
- Last Synced: 2024-04-09T05:39:29.331Z (9 months ago)
- Topics: dbp, digital-blueprint, dispatch
- Language: JavaScript
- Homepage:
- Size: 3.03 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Dispatch Application
[GitHub Repository](https://github.com/digital-blueprint/dispatch-app) |
[npmjs package](https://www.npmjs.com/package/@digital-blueprint/dispatch-app) |
[Unpkg CDN](https://unpkg.com/browse/@digital-blueprint/dispatch-app/) |
[Dispatch Bundle](https://github.com/digital-blueprint/relay-dispatch-bundle)
[](https://github.com/digital-blueprint/dispatch-app/actions/workflows/build-test-publish.yml)
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](https://github.com/digital-blueprint/relay-server-template) running
- You need the [DBP Dispatch Bundle](https://github.com/digital-blueprint/relay-dispatch-bundle)
## Local development
```bash
# get the source
git clone [email protected]: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](https://github.com/digital-blueprint/webapppassword) Nextcloud app like this
[Nextcloud Development Environment](https://github.com/digital-blueprint/webapppassword/tree/main/docker).
## Use app via Docker
### docker-compose.yml
```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
### Install app
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](https://unpkg.com/browse/@digital-blueprint/dispatch-app/)
for example like this: [dbp-dispatch/index.html](https://github.com/digital-blueprint/dispatch-app/tree/main/examples/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.
### Update app
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](https://unpkg.com/browse/@digital-blueprint/dispatch-app/)
for example the `dbp-qualified-dispatch-pdf-upload` activity to qualifiedly sign PDF documents like this:
[dbp-qualified-dispatch-pdf-upload/index.html](https://github.com/digital-blueprint/dispatch-app/tree/main/examples/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](https://github.com/digital-blueprint/dispatch-app/tree/main/src).
## Adapt app
### Functionality
You can add multiple attributes to the `` tag.
| attribute name | value | Link to description |
|----------------|-------|-------------------------------------------------------------------------------------------------------------------------------------|
| `provider-root` | Boolean | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |
| `lang` | String | [language-select](https://github.com/digital-blueprint/toolkit/tree/main/packages/language-select#attributes) |
| `entry-point-url` | String | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |
| `keycloak-config` | Object | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |
| `base-path` | String | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |
| `src` | String | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |
| `html-overrides` | String | [common](https://github.com/digital-blueprint/toolkit/tree/main/packages/common#overriding-slots-in-nested-web-components) |
| `themes` | Array | [theme-switcher](https://github.com/digital-blueprint/toolkit/tree/main/packages/theme-switcher#themes-attribute) |
| `darkModeThemeOverride` | String | [theme-switcher](https://github.com/digital-blueprint/toolkit/tree/main/packages/theme-switcher#themes-attribute) |
#### 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
```
### Design
For frontend design customizations, such as logo, colors, font, favicon, and more, take a look at the [theming documentation](https://handbook.digital-blueprint.org/frameworks/frontend/theming/).
## "dbp-dispatch" slots
These are common slots for the app-shell. You can find the documentation of these slots in the [app-shell documentation](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell).
For the app specific slots take a look at the [dispatch activities](https://github.com/digital-blueprint/dispatch-app/tree/main/src).