diff --git a/packages/app-shell/.npmignore b/packages/app-shell/.npmignore new file mode 100644 index 0000000000000000000000000000000000000000..bd8138ceb1b9d6026edec0d20ac4be9940d5cf73 --- /dev/null +++ b/packages/app-shell/.npmignore @@ -0,0 +1,5 @@ +node_modules +.idea +npm-debug.log +package-lock.json +index.html diff --git a/packages/app-shell/README.md b/packages/app-shell/README.md index f70ee1d755ae3eb84f4c621c750b063f614884ca..c7c23e5bc77b72b2cbbc3329f331a970dbb9ee22 100644 --- a/packages/app-shell/README.md +++ b/packages/app-shell/README.md @@ -3,10 +3,17 @@ A web component for building SPAs consisting of one topic with multiple activities. Handles login, language selection, activity switching, menus etc. +You can install these component via npm: + +```bash +npm i @dbp-toolkit/app-shell +``` + ## Usage ```html <dbp-app-shell src="/example.topic.metadata.json"></dbp-app-shell> +<script type="module" src="node_modules/@dbp-toolkit/app-shell/dist/dbp-app-shell.js"></script> ``` ## Attributes @@ -83,6 +90,9 @@ yarn run watch # run tests yarn test + +# build local packages in dist directory +yarn run build ``` Jump to <http://localhost:8002> and you should get a Single Sign On login page. diff --git a/packages/app-shell/package.json b/packages/app-shell/package.json index 8069e9012b312c2a2ba90b8f3127652dd1b6c0dc..ae825cd9cbfab1c1074c3dc0f991ad0478023337 100644 --- a/packages/app-shell/package.json +++ b/packages/app-shell/package.json @@ -1,10 +1,9 @@ { "name": "@dbp-toolkit/app-shell", "homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell", - "version": "0.1.0", + "version": "0.1.1", "main": "src/index.js", "license": "LGPL-2.1-or-later", - "private": true, "devDependencies": { "@rollup/plugin-commonjs": "^16.0.0", "@rollup/plugin-json": "^4.1.0",