{"id":13565520,"url":"https://github.com/arkivverket/archive-uploader","last_synced_at":"2025-04-03T22:31:39.180Z","repository":{"id":37965545,"uuid":"159724987","full_name":"arkivverket/archive-uploader","owner":"arkivverket","description":"A simple TUSD upload client.","archived":false,"fork":false,"pushed_at":"2023-07-19T01:21:55.000Z","size":14305,"stargazers_count":3,"open_issues_count":23,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-14T21:54:09.666Z","etag":null,"topics":["electron","oslo-1","react","tus","tusd"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arkivverket.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2018-11-29T20:43:42.000Z","updated_at":"2023-06-04T09:57:22.000Z","dependencies_parsed_at":"2024-01-16T19:01:41.031Z","dependency_job_id":"e20d73e8-e64b-4d74-8197-7fba72d8d824","html_url":"https://github.com/arkivverket/archive-uploader","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkivverket%2Farchive-uploader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkivverket%2Farchive-uploader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkivverket%2Farchive-uploader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkivverket%2Farchive-uploader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arkivverket","download_url":"https://codeload.github.com/arkivverket/archive-uploader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247090262,"owners_count":20881940,"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":["electron","oslo-1","react","tus","tusd"],"created_at":"2024-08-01T13:01:49.073Z","updated_at":"2025-04-03T22:31:38.036Z","avatar_url":"https://github.com/arkivverket.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Archive Digitisation Uploader\n\n## Getting started\n\nClone the repo and run the following command:\n\n```console\nnpm install\n```\n\nNext you can start the application in development mode using the following command:\n\n```console\nnpm run start\n```\n\n\u003e 💡 React components will automatically be reloaded when modified. However, if you make changes to the Electron main process files (`public/*`) then you'll have to restart the application.\n\n## Build for production\n\nIf you want to build a production-ready version the application for macOS then use the following command:\n\n```console\nnpm run build-mac\n```\n\nIf you want to build a production-ready version the application for Windows then use the following command:\n\n```console\nnpm run build-win\n```\n\n\u003e ⚠️ Building signed versions should only be done on the dedicated code-signing machine.\n\n## Build for test\n\nIf you want to build a production-ready unsigned version the application for macOS then use the following command:\n\n```console\nnpm run build-mac-test\n```\n\nIf you want to build a production-ready unsigned version the application for Windows then use the following command:\n\n```console\nnpm run build-win-test\n```\n\n---\n\n## Protocol\n\nThe application will be launched using the custom `dpldr` protocol. The link will consist of the protocol followed by a base64 enoded JSON payload:\n\n```text\ndpldr://eyJmb2xkZXJOYW1lIjoxNTQzOTI1NDM2LCJ1cGxvYWRVcmwiOiJodHRwOlwvXC9leGFtcGxlLm9yZ1wvdXBsb2FkIiwibWV0YSI6eyJ1c2VySWQiOjEyMywidW5pdElkIjoxMjMsImZvbGRlck5hbWUiOjE1NDM5MjU0MzZ9fQ==\n```\n\n\u003e Note that the protocol is `dpldrdev` when the application run in development mode.\n\nThe payload must contain the following data. Note that the meta block is optional (in this example it is specific for the Archive Digitisation application):\n\n```php\n$data = [\n    'reference'  =\u003e 'RA/EA-4070/Ki/L0009',       // (required) Name or reference that lets the user identify of the upload\n    'uploadUrl'  =\u003e 'http://example.org/upload', // (required) URL to the tusd endpoint\n    'uploadType' =\u003e 'directory',                 // (optional) Upload type. The allowed types are 'directory' and 'tar' (default: 'directory')\n    'meta'       =\u003e [                            // (optional) Metadata that is sent back to the tusd server when the upload starts\n        'userId'     =\u003e 123, // Value must be signed\n        'unitId'     =\u003e 123, // Value must be signed\n        'folderName' =\u003e 123, // Value must be signed\n    ],\n];\n```\n\n\u003e The meta values must be signed by the Archive Digitisation application as they will be used to validate the upload using a TUS hook.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkivverket%2Farchive-uploader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farkivverket%2Farchive-uploader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkivverket%2Farchive-uploader/lists"}