Skip to content
Snippets Groups Projects
Unverified Commit 2cc0338c authored by Bekerle, Patrizio's avatar Bekerle, Patrizio :fire:
Browse files

Update install and build documentation (#36)

parent 1c372cfd
No related branches found
No related tags found
No related merge requests found
Pipeline #14036 passed
......@@ -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.
......@@ -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.
......@@ -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.
......@@ -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.
......
......@@ -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.
......@@ -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
```
......@@ -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.
......@@ -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.
......@@ -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.
......@@ -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.
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment