How to install packages?

How would one install a package? They don't seem to be published on npmjs.org, installing via git is hard (not possible with npm and packages in subfolders?) and from a local folder seems to fail with because of dependencies between packages.

Please provide info in the README or publish them on npmjs.org or elsewhere.

Thank you for drawing attention to the documentation. I'll work on that.

mentioned in commit 2cc0338c

I now updated the documentation of the packages. In the future we are also planning to put them on npmjs.org. Please let us know if you have problems building them or see anything else amiss.

closed

@pbeke Thanks for updating the documentation! This helps with developing toolkit itself.

But how would I include a toolkit package into for example my own project in local development? As described above, it is at least not as simple as npm install dbp-app-shell (not in npmjs.org repo), npm install git+ssh://git@gitlab.tugraz.at:dbp/web-components/toolkit.git (doesn't point to specific package in a folder) or local npm install ../toolkit/packages/app-shell or npm link (fails because of cross-dependencies that are not found in the npmjs.org repo). I suspect using "lerna" could help, I may try again tomorrow.

reopened

In our apps we are including the toolkit as git submodule, like here: https://gitlab.tugraz.at/dbp/apps/authenticdocument/-/tree/master/vendor

We are using rollup for bundling things together, see: https://gitlab.tugraz.at/dbp/apps/authenticdocument/-/blob/master/rollup.config.js

Other than that you can always just build the components as described in the READMEs and just load the js files in your project.

Btw. git submodule update --init in app-shell is broken fatal: No url found for submodule path '../notification/vendor/common' in .gitmodules, they all point to repositories that I don't have access to or that don't exist anymore.

@987FCF504483CBC8, do we need the .gitmodule files in the packages/* directories?

Those .gitmodules are leftovers from when the packages were in separate repos. They should be deleted as we don't use any git submodules in the toolkit repo anymore.

I'll delete them, thank you @6117DA7AD501469E for pointing that out.

mentioned in commit 64d96099

And in every readme there is still a git submodule update --init line.. which should be replaced with lerna bootstrap, I guess..

mentioned in commit 2fa9321a

No, they just need to be removed (I did that now).

And in every readme there is still a git submodule update --init line.. which should be replaced with lerna bootstrap, I guess..

We use lerna just for running tests in parallel, because yarn doesn't support that. I've added something in 0d52d551

Back to the initial question: We currently include this repo as a submodule in our apps and there include all the packages using yarn workspaces. We haven't looked into packaging for npm etc. yet.

Thanks for your support, I think I'll just closely follow https://gitlab.tugraz.at/dbp/apps/authenticdocument and try to set something up with yarn workspaces, gitsubmodule and rollup.

I would still ask to publish packages on npmjs.org and to make this repository public. Would make building on it possible and it is LGPL licensed anyway.

I would still ask to publish packages on npmjs.org and to make this repository public.

That's on our roadmap. PRs welcome.

mentioned in commit 06b29a4a