Skip to content
Snippets Groups Projects

Matomo web component

Merged Neuber, Eugen Ramon requested to merge matomo-component into master
1 file
+ 15
8
Compare changes
  • Side-by-side
  • Inline
@@ -16,9 +16,13 @@ activities. Handles login, language selection, activity switching, menus etc.
- `lang` (optional, default: `de`): set to `de` or `en` for German or English
- example `<dbp-app-shell lang="de" </dbp-app-shell>`
- `src`: The path to a topic metadata file (json)
- `base-path` (optional, default: `/`: An absolute base path for routing
- `base-path` (optional, default: `/`): An absolute base path for routing
- `entry-point-url`: Entry point URL to access the API
- `keycloak-config`: An object with the following keys: url, realm, clientId, silentCheckSsoRedirectUri, scope
- `matomo-url` (optional): set to your *Matomo* server (required only for tracking)
- example `<dbp-app-shell matomo-url="https://my-matomo.tld"></dbp-app-shell>`
- `matomo-site-id` (optional): set to your site id (required only for tracking)
- example `<dbp-app-shell matomo-site-id="456789"></dbp-app-shell>`
## Topic Metadata
@@ -38,13 +42,13 @@ activities. Handles login, language selection, activity switching, menus etc.
},
"routing_name": "example",
"activities": [
{"path": "example.metadata.json", visible: true}
{"path": "example.metadata.json", "visible": true}
],
"attributes": []
}
```
## Activity Metada
## Activity Metadata
```json
{
@@ -70,15 +74,18 @@ activities. Handles login, language selection, activity switching, menus etc.
```bash
# get the source
git clone git@gitlab.tugraz.at:dbp/apps/AppShell.git
cd AppShell
git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
cd toolkit/packages/app-shell
git submodule update --init
# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
npm install
yarn install
# constantly build dist/bundle.js and run a local web-server on port 8002
npm run watch
# constantly build dist/bundle.js and run a local web-server on port 8002
yarn run watch
# run tests
yarn test
```
Jump to <http://localhost:8002> and you should get a Single Sign On login page.
Loading