Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Toolkit
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
digital blueprint
Web Component Framework
Toolkit
Commits
a68a09a3
Commit
a68a09a3
authored
4 years ago
by
Neuber, Eugen Ramon
Browse files
Options
Downloads
Patches
Plain Diff
Improve README.md
See issue
#29
parent
0942162b
No related branches found
No related tags found
1 merge request
!2
Matomo web component
Pipeline
#13077
passed
4 years ago
Stage: test
Changes
1
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
packages/app-shell/README.md
+15
-8
15 additions, 8 deletions
packages/app-shell/README.md
with
15 additions
and
8 deletions
packages/app-shell/README.md
+
15
−
8
View file @
a68a09a3
...
@@ -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 Metada
ta
```
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
AppS
hell
cd
toolkit/packages/app-s
hell
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.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment