Frontend App README Template

{{Name}} Application

GitHub Repository | npmjs package | Unpkg CDN | {{Name}} Bundle | Project documentation

{{app-description}}

Prerequisites

• You need the API server running
• You need the {{bundle-name}}
• For more information please visit the {{name}} project documentation

Local development

# get the source
git clone https://github.com/{{app-path}}.git
cd signature
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_local/
npm run watch-local


# run tests
npm test

Jump to http://localhost:8001 and you should get a Single Sign On login page.

Using this app as pre-built package

Install app

If you want to install the DBP Signature App in a new folder {{name}}-app with a path prefix / you can call:

npx @digital-blueprint/cli install-app {{name}} {{name}}-app /

For more information on the "install-app" command see https://gitlab.tugraz.at/dbp/cli/#install-apps

Afterwards you can point your Apache web-server to {{name}}-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 {{name}}-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-{{name}}/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 {{name}} App in the current folder you can call:

npx @digital-blueprint/cli update-app {{name}}

Activities

This app has the following activities:

• {{list-of-activities}}

You can find the documentation of these activities in the {{name}} activities documentation.

Adapt app

Functionality

You can add multiple attributes to the <dbp-{{name}}> tag.

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

{{app-based-attributes}}

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:

<dbp-{{name}}
    auth
    requested-login-status
    analytics-event
>
</dbp-{{name}}>

Design

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

"dbp-{{name}}" 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 {{name}} activities.