From a0785f3edf92d4b46d2ef590f06fc10a99c58c63 Mon Sep 17 00:00:00 2001
From: Christoph Reiter <reiter.christoph@gmail.com>
Date: Wed, 15 Apr 2020 11:38:26 +0200
Subject: [PATCH] Add a basic readme
---
packages/app-shell/README.md | 83 ++++++++++++++++++++++++++++
packages/app-shell/assets/index.html | 2 +-
2 files changed, 84 insertions(+), 1 deletion(-)
diff --git a/packages/app-shell/README.md b/packages/app-shell/README.md
index e69de29b..a72fabc7 100644
--- a/packages/app-shell/README.md
+++ b/packages/app-shell/README.md
@@ -0,0 +1,83 @@
+# VPU App Shell Component
+
+[GitLab Repository](https://gitlab.tugraz.at/VPU/Apps/AppShell)
+
+A web component for building SPAs consisting of one topic with multiple
+activities. Handles login, language selection, activity switching, menus etc.
+
+## Usage
+
+```html
+<vpu-app src="/example.topic.metadata.json"></vpu-app>
+```
+
+## Attributes
+
+- `lang` (optional, default: `de`): set to `de` or `en` for German or English
+ - example `<vpu-auth lang="de" </vpu-auth>`
+- `src`: The path to a topic metadata file (json)
+- `base-path` (optional, default: `/`: An absolute base path for routing
+- `entry-point-url`: Entry point URL to access the API
+
+## Topic Metadata
+
+```json
+{
+ "name": {
+ "de": "Beispiel",
+ "en": "Example"
+ },
+ "short_name": {
+ "de": "Beispiel",
+ "en": "Example"
+ },
+ "description": {
+ "de": "Ich bin eine Beschreibung der Applikation",
+ "en": "I am a description of this application"
+ },
+ "routing_name": "example",
+ "activities": [
+ {"path": "example.metadata.json", visible: true}
+ ],
+ "attributes": []
+}
+```
+
+## Activity Metada
+
+```json
+{
+ "element": "vpu-activity-example",
+ "module_src": "vpu-activity-example.js",
+ "routing_name": "activity-example",
+ "name": {
+ "de": "Beispielaktivität",
+ "en": "Example Activity"
+ },
+ "short_name": {
+ "de": "Beispielaktivität",
+ "en": "Example Activity"
+ },
+ "description": {
+ "de": "Eine Beschreibung",
+ "en": "A Description"
+ }
+}
+```
+
+## Local development
+
+```bash
+# get the source
+git clone git@gitlab.tugraz.at:VPU/Apps/AppShell.git
+cd AppShell
+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
+
+# constantly build dist/bundle.js and run a local web-server on port 8002
+npm run watch
+```
+
+Jump to <http://localhost:8002> and you should get a Single Sign On login page.
diff --git a/packages/app-shell/assets/index.html b/packages/app-shell/assets/index.html
index cc89a804..6cd1c659 100644
--- a/packages/app-shell/assets/index.html
+++ b/packages/app-shell/assets/index.html
@@ -15,7 +15,7 @@
<body>
-<vpu-app lang="de" src="/example.topic.metadata.json"></vpu-app>
+<vpu-app src="/example.topic.metadata.json"></vpu-app>
</body>
</html>
\ No newline at end of file
--
GitLab