Check-in Application

GitHub Repository | npmjs package | Unpkg CDN | Checkin Bundle | Project documentation

A simple location based contact tracing system. With the possibilities to check in yourself or a guest manually or with an in-build QR-Code scanner.

Prerequisites

• You need the API server running
• You need the RelayCheckinBundle to handle check-ins to places and contact tracing for warning about COVID-19 cases
• For more information please visit the Check-in project documentation

Local development

# get the source
git clone [email protected]:digital-blueprint/checkin-app.git
cd checkin-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 tohttps://localhost:8001, so you should get a Single Sign On login page.

To enable building with custom assets, you need to provide your custom assets in the directory assets_custom/checkin-app/assets/. If you want to, you can also change this path in the file rollup.config.js. For more information, please visit the dbp handbook page on custom assets.

Using this app as pre-built package

Install app

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

npx @digital-blueprint/cli install-app check-in check-in-app /

Warning: There may be issues when you run these commands as root user, best use a non-root user, like www-data. To do this you can for example open a shell with runuser -u www-data -- bash.

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

npx @digital-blueprint/cli update-app check-in

Warning: There may be issues when you run these commands as root user, best use a non-root user, like www-data. To do this you can for example open a shell with runuser -u www-data -- bash.

Activities

This app has the following activities:

• dbp-check-in-request
• dbp-check-out-request
• dbp-guest-check-in
• dbp-report-risk

You can find the documentation of these activities in the check-in activities documentation.

Adapt app

Functionality

You can add multiple attributes to the <dbp-check-in> 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 | | no-welcome-page | Boolean | appshell | html-overrides | String | common | | themes | Array | theme-switcher | | darkModeThemeOverride | String | theme-switcher | | search-hash-string | String | check-in activities

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-check-in
    auth
    requested-login-status
    analytics-event
    ...
>
</dbp-check-in>

So a working example would be:

<dbp-check-in
    provider-root
    lang="de"
    entry-point-url="http://your.api"
    search-hash-string="unicheckin"
    html-overrides="global-override"
    src="/path/dbp-check-in.topic.metadata.json"
    base-path="/"
    keycloak-config='{"url": "https://keyclock.url/auth", "realm": "your-realm", "clientId": "your-client-id", "silentCheckSsoRedirectUri": "/path/silent-check-sso.html"}'
><dbp-loading-spinner></dbp-loading-spinner>
</dbp-check-in>

See AppShell Attributes for a list of more attributes.

See Overriding slots in nested web components for information about how to override slots.

Design

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

"dbp-check-in" 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 check-in activities.