diff --git a/packages/auth/README.md b/packages/auth/README.md index 374bdab570f61e764307508177fcd36f0198101c..21480ed1264cb27f6171d5cbc7cad0f6f86406f6 100644 --- a/packages/auth/README.md +++ b/packages/auth/README.md @@ -47,15 +47,18 @@ ```bash # get the source -git clone git@gitlab.tugraz.at:dbp/web-components/Auth.git -cd Auth +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/auth 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 +# install dependencies +yarn install # constantly build dist/bundle.js and run a local web-server on port 8002 -npm run watch-local +yarn run watch-local + +# 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/check-in-place-select/README.md b/packages/check-in-place-select/README.md index ba41dc3155743065e9764ec6f0d4f40db962bb0c..5b6ac934ce94c8d7928c396230d9a739b9decd59 100644 --- a/packages/check-in-place-select/README.md +++ b/packages/check-in-place-select/README.md @@ -42,6 +42,9 @@ yarn run watch-local # 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/data-table-view/README.md b/packages/data-table-view/README.md index f09d8942fc5a7a58077b4b07f81c4113e44e6d61..92d2637d9caeffe9f3ba82f5bfd2a9a8618ec939 100644 --- a/packages/data-table-view/README.md +++ b/packages/data-table-view/README.md @@ -26,15 +26,18 @@ # Local development ```bash # get the source -git clone git@gitlab.tugraz.at:dbp/web-components/DataTableView.git -cd DataTableView +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/data-table-view 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 +# install dependencies +yarn install -# constantly build dist/bundle.js and run a local web-server on port 8003 -npm run watch-local +# constantly build dist/bundle.js and run a local web-server on port 8002 +yarn run watch-local + +# build local packages in dist directory +yarn run build ``` Jump to <http://localhost:8003> and you should get a demo page. diff --git a/packages/file-handling/README.md b/packages/file-handling/README.md index ac909241448fe2b68c54baa0a6a42a350c6eba32..14cac2a9142ac0e7dc9db30da7b14c2e35d99664 100644 --- a/packages/file-handling/README.md +++ b/packages/file-handling/README.md @@ -88,16 +88,19 @@ files to a [Nextcloud](https://nextcloud.com/) instance. ## Local development ```bash -# get the source code -git clone git@gitlab.tugraz.at:dbp/web-components/FileHandling.git -cd FileHandling +# get the source +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/file-handling 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 +# install dependencies +yarn install # constantly build dist/bundle.js and run a local web-server on port 8002 -npm run watch-local +yarn run watch-local + +# build local packages in dist directory +yarn run build ``` Jump to <http://localhost:8002> and you should get a demo page. diff --git a/packages/knowledge-base-web-page-element-view/README.md b/packages/knowledge-base-web-page-element-view/README.md index 63cf58594c02118f1856fee7c8d23922183ec47a..7b510b99cae4d8075323ac28b558913cb4914304 100644 --- a/packages/knowledge-base-web-page-element-view/README.md +++ b/packages/knowledge-base-web-page-element-view/README.md @@ -21,15 +21,18 @@ ```bash # get the source -git clone git@gitlab.tugraz.at:dbp/web-components/KnowledgeBaseWebPageElementView.git -cd KnowledgeBaseWebPageElementView +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/knowledge-base-web-page-element-view 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 +# install dependencies +yarn install # constantly build dist/bundle.js and run a local web-server on port 8002 -npm run watch-local +yarn run watch-local + +# build local packages in dist directory +yarn run build ``` Jump to <http://localhost:8002> and you should get a demo page. diff --git a/packages/language-select/README.md b/packages/language-select/README.md index 43d9b8f11e9bbe7867dee734dafdb58914831857..b7688bbf9fe8f54f23c9e9b99d8fac01805279bf 100644 --- a/packages/language-select/README.md +++ b/packages/language-select/README.md @@ -4,16 +4,16 @@ ```bash # get the source -git clone git@gitlab.tugraz.at:dbp/web-components/LanguageSelect.git -cd LanguageSelect +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/language-select 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 +# install dependencies +yarn install # constantly build dist/bundle.js and run a local web-server on port 8002 -npm run watch-local +yarn run watch-local -# run tests -npm test +# build local packages in dist directory +yarn run build ``` diff --git a/packages/matomo/README.md b/packages/matomo/README.md index 4c90758b3de20dfc311141218925ec3d9c46b23c..eead62eff4e7b6df8b84389117baabce5d28f697 100644 --- a/packages/matomo/README.md +++ b/packages/matomo/README.md @@ -48,6 +48,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 demo page. diff --git a/packages/notification/README.md b/packages/notification/README.md index 2a1d4d2304c92a23f13bb61b877a0aa47aa0e355..2218b8e88411c47589e53edcb298df0c470fc2c6 100644 --- a/packages/notification/README.md +++ b/packages/notification/README.md @@ -28,18 +28,21 @@ send({ ```bash # get the source -git clone git@gitlab.tugraz.at:dbp/web-components/Notification.git -cd Notification +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/notification 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 +# install dependencies +yarn install # constantly build dist/bundle.js and run a local web-server on port 8002 -npm run watch-local +yarn run watch # run tests -npm test +yarn test + +# build local packages in dist directory +yarn run build ``` Jump to <http://localhost:8002> and you should get a demo page. diff --git a/packages/person-profile/README.md b/packages/person-profile/README.md index b2cc2a5b17bef144578419aee9259a62fc5c6194..e63547ed398582dcf4ca5d0accde712e2bf6921c 100644 --- a/packages/person-profile/README.md +++ b/packages/person-profile/README.md @@ -19,18 +19,21 @@ ```bash # get the source -git clone git@gitlab.tugraz.at:dbp/web-components/PersonProfile.git -cd PersonProfile +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/person-profile 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 +# install dependencies +yarn install # constantly build dist/bundle.js and run a local web-server on port 8002 -npm run watch-local +yarn run watch # run tests -npm test +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/person-select/README.md b/packages/person-select/README.md index 89b9115653b385b7ce8df51239a5c71f80c04680..21b33193b1ed7ca7ad074f015d02eb1acec1c324 100644 --- a/packages/person-select/README.md +++ b/packages/person-select/README.md @@ -31,18 +31,21 @@ ```bash # get the source -git clone git@gitlab.tugraz.at:dbp/web-components/PersonSelect.git -cd PersonSelect +git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git +cd toolkit/packages/person-select 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 +# install dependencies +yarn install # constantly build dist/bundle.js and run a local web-server on port 8002 -npm run watch-local +yarn run watch # run tests -npm test +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/qr-code-scanner/README.md b/packages/qr-code-scanner/README.md index 28b0bdf7c6267e9d13042bb20fe2b804fb1706ef..95a2d72b4e22de9df91d861f3e0479a94abe733f 100644 --- a/packages/qr-code-scanner/README.md +++ b/packages/qr-code-scanner/README.md @@ -48,6 +48,9 @@ yarn run watch-local # run tests yarn test + +# build local packages in dist directory +yarn run build ``` Jump to <http://localhost:8002> and you should get a demo page.