{"id":18724578,"url":"https://github.com/digital-blueprint/esign-app","last_synced_at":"2025-04-12T15:32:05.601Z","repository":{"id":65487875,"uuid":"593133612","full_name":"digital-blueprint/esign-app","owner":"digital-blueprint","description":"Document Signing Application","archived":false,"fork":false,"pushed_at":"2025-04-07T14:37:43.000Z","size":5611,"stargazers_count":4,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T15:36:39.655Z","etag":null,"topics":["dbp","dbp-esign","digital-blueprint","esign","esignature"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/digital-blueprint.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-25T10:14:18.000Z","updated_at":"2025-04-07T14:37:47.000Z","dependencies_parsed_at":"2024-04-15T06:59:27.375Z","dependency_job_id":"85ead577-9221-43f0-83a9-9ec734af39bb","html_url":"https://github.com/digital-blueprint/esign-app","commit_stats":{"total_commits":1242,"total_committers":15,"mean_commits":82.8,"dds":0.6972624798711755,"last_synced_commit":"20c338355d5e6fe6d6424df2467c7043c3aae3db"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-blueprint%2Fesign-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-blueprint%2Fesign-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-blueprint%2Fesign-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-blueprint%2Fesign-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/digital-blueprint","download_url":"https://codeload.github.com/digital-blueprint/esign-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248589745,"owners_count":21129678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dbp","dbp-esign","digital-blueprint","esign","esignature"],"created_at":"2024-11-07T14:07:11.990Z","updated_at":"2025-04-12T15:32:05.590Z","avatar_url":"https://github.com/digital-blueprint.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Digital Signing Application\n\n[GitHub Repository](https://github.com/digital-blueprint/esign-app) |\n[npmjs package](https://www.npmjs.com/package/@digital-blueprint/esign-app) |\n[Unpkg CDN](https://unpkg.com/browse/@digital-blueprint/esign-app/) |\n[Esign Bundle](https://gitlab.tugraz.at/dbp/esign/dbp-relay-esign-bundle) |\n[Project documentation](https://dbp-demo.tugraz.at/site/software/esign.html)\n\n[![Build and Test](https://github.com/digital-blueprint/esign-app/actions/workflows/build-test-publish.yml/badge.svg)](https://github.com/digital-blueprint/esign-app/actions/workflows/build-test-publish.yml)\n\nEsign - The digital signature service at the university.\n\n## Prerequisites\n\n- You need the [API server](https://github.com/digital-blueprint/relay-server-template) running\n- You need the [DbpRelayEsignBundle](https://github.com/digital-blueprint/relay-esign-bundle) to allow signing of PDF files\n- For more information please visit the [ESign project documentation](https://handbook.digital-blueprint.org/blueprints/esign/)\n\n## Local development\n\n```bash\n# get the source\ngit clone git@github.com:digital-blueprint/esign-app.git\ncd esign-app\ngit submodule update --init\n\n# install dependencies\nnpm install\n\n# constantly build dist/bundle.js and run a local web-server on port 8001\nnpm run watch\n\n# constantly build dist/bundle.js and run a local web-server on port 8001 using a custom assets directory assets_custom/\nnpm run watch-custom\n\n# run tests\nnpm test\n```\n\nJump to \u003chttp://localhost:8001\u003e and you should get a Single Sign On login page.\n\nTo use the Nextcloud functionality you need a running Nextcloud server with the\n[webapppassword](https://github.com/digital-blueprint/webapppassword) Nextcloud app like this\n[Nextcloud Development Environment](https://github.com/digital-blueprint/webapppassword/tree/main/docker).\n\n## Using this app as pre-built package\n\n### Install app\n\nIf you want to install the DBP Signature App in a new folder `signature-app` with a path prefix `/` you can call:\n\n```bash\nnpx @digital-blueprint/cli install-app signature signature-app /\n```\n\nAfterwards you can point your Apache web-server to `signature-app/public`.\n\nMake sure you are allowing `.htaccess` files in your Apache configuration.\n\nAlso make sure to add all of your resources you are using (like your API and Keycloak servers) to the\n`Content-Security-Policy` in your `signature-app/public/.htaccess`, so the browser allows access to those sites.\n\nYou can also use this app directly from the [Unpkg CDN](https://unpkg.com/browse/@digital-blueprint/esign-app/)\nfor example like this: [dbp-signature/index.html](https://github.com/digital-blueprint/esign-app/-/tree/master/examples/dbp-signature/index.html)\n\nNote that you will need a Keycloak server along with a client id for the domain you are running this html on.\n\n### Update app\n\nIf you want to update the DBP Signature App in the current folder you can call:\n\n```bash\nnpx @digital-blueprint/cli update-app signature\n```\n\n## Activities\n\nYou can find the documentation of these activities in the [esign activities documentation](https://github.com/digital-blueprint/esign-app/tree/main/src).\n\n## Adapt app\n\n### Functionality\n\nYou can add multiple attributes to the `\u003cdbp-signature\u003e` tag.\n\n| attribute name | value | Link to description |\n|----------------|-------| ------------|\n| `provider-root` | Boolean | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |\n| `lang`         | String | [language-select](https://github.com/digital-blueprint/toolkit/tree/main/packages/language-select#attributes) |\n| `entry-point-url` | String | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |\n| `keycloak-config` | Object | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |\n| `base-path` | String | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |\n| `src` | String | [app-shell](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell#attributes) |\n| `html-overrides` | String | [common](https://github.com/digital-blueprint/toolkit/tree/main/packages/common#overriding-slots-in-nested-web-components) |\n| `themes` | Array | [theme-switcher](https://github.com/digital-blueprint/toolkit/tree/main/packages/theme-switcher#themes-attribute) |\n| `darkModeThemeOverride` | String | [theme-switcher](https://github.com/digital-blueprint/toolkit/tree/main/packages/theme-switcher#themes-attribute) |\n| `file-handling-enabled-targets` | String | [file-handling](https://github.com/digital-blueprint/toolkit/tree/main/packages/file-handling#attributes) |\n| `nextcloud-web-app-password-url` | String | [file-handling](https://github.com/digital-blueprint/toolkit/tree/main/packages/file-handling#attributes) |\n| `nextcloud-web-dav-url` | String | [file-handling](https://github.com/digital-blueprint/toolkit/tree/main/packages/file-handling#attributes) |\n| `nextcloud-file-url` | String | [file-handling](https://github.com/digital-blueprint/toolkit/tree/main/packages/file-handling#attributes) |\n| `nextcloud-auth-info` | String | [file-handling](https://github.com/digital-blueprint/toolkit/tree/main/packages/file-handling#attributes) |\n| `nextcloud-name` | String | [file-handling](https://github.com/digital-blueprint/toolkit/tree/main/packages/file-handling#attributes) |\n| `allow-annotating` | Boolean | [esign activities](https://github.com/digital-blueprint/esign-app/tree/main/src) |\n| `file-handling-enabled-targets` | String | [esign activities](https://github.com/digital-blueprint/esign-app/tree/main/src) |\n\n#### Mandatory attributes\n\nIf you are not using the `provider-root` attribute to \"terminate\" all provider attributes\nyou need to manually add these attributes so that the topic will work properly:\n\n```html\n\u003cdbp-signature\n        auth\n        requested-login-status\n        analytics-event\n        initial-file-handling-state\n        clipboard-files\n\u003e\n\u003c/dbp-signature\u003e\n```\n\n### Design\n\nFor frontend design customizations, such as logo, colors, font, favicon, and more, take a look at the [theming documentation](https://handbook.digital-blueprint.org/frameworks/frontend/theming/).\n\n## \"dbp-signature\" slots\n\nThese are common slots for the app-shell. You can find the documentation of these slots in the [app-shell documentation](https://github.com/digital-blueprint/toolkit/tree/main/packages/app-shell).\nFor the app specific slots take a look at the [esign activities documentation](https://github.com/digital-blueprint/esign-app/tree/main/src).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-blueprint%2Fesign-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdigital-blueprint%2Fesign-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-blueprint%2Fesign-app/lists"}