Skip to content
Snippets Groups Projects
Commit a68a09a3 authored by Neuber, Eugen Ramon's avatar Neuber, Eugen Ramon :speech_balloon:
Browse files

Improve README.md

See issue #29
parent 0942162b
No related branches found
No related tags found
1 merge request!2Matomo web component
Pipeline #13077 passed
This commit is part of merge request !2. Comments created here will be created in the context of that merge request.
...@@ -16,9 +16,13 @@ activities. Handles login, language selection, activity switching, menus etc. ...@@ -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 - `lang` (optional, default: `de`): set to `de` or `en` for German or English
- example `<dbp-app-shell lang="de" </dbp-app-shell>` - example `<dbp-app-shell lang="de" </dbp-app-shell>`
- `src`: The path to a topic metadata file (json) - `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 - `entry-point-url`: Entry point URL to access the API
- `keycloak-config`: An object with the following keys: url, realm, clientId, silentCheckSsoRedirectUri, scope - `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 ## Topic Metadata
...@@ -38,13 +42,13 @@ activities. Handles login, language selection, activity switching, menus etc. ...@@ -38,13 +42,13 @@ activities. Handles login, language selection, activity switching, menus etc.
}, },
"routing_name": "example", "routing_name": "example",
"activities": [ "activities": [
{"path": "example.metadata.json", visible: true} {"path": "example.metadata.json", "visible": true}
], ],
"attributes": [] "attributes": []
} }
``` ```
## Activity Metada ## Activity Metadata
```json ```json
{ {
...@@ -70,15 +74,18 @@ activities. Handles login, language selection, activity switching, menus etc. ...@@ -70,15 +74,18 @@ activities. Handles login, language selection, activity switching, menus etc.
```bash ```bash
# get the source # get the source
git clone git@gitlab.tugraz.at:dbp/apps/AppShell.git git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
cd AppShell cd toolkit/packages/app-shell
git submodule update --init git submodule update --init
# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically) # 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 # constantly build dist/bundle.js and run a local web-server on port 8002
npm run watch yarn run watch
# run tests
yarn test
``` ```
Jump to <http://localhost:8002> and you should get a Single Sign On login page. Jump to <http://localhost:8002> and you should get a Single Sign On login page.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment