Skip to content

Latest commit

 

History

249 Commits

Folders and files

Repository files navigation

collection2crate

Turn a folder of files into an RO-Crate, in the browser.

This repo is an npm workspaces monorepo with two packages:

Workspace Folder What it is
collection2crate packages/app The browser app and its plugin engine. Spec: SPEC.md, SPEC-UI.md
collection2crate-plugins packages/app-plugins The build plugins the app bundles. See README.md, SPEC-PLUGINS.md

Getting started

Needs Node 22 and a Chromium-based browser (the app uses the File System Access API).

npm install
npm run dev

Other commands, all run from the repo root:

npm test                                # every suite in both packages
npm run build                           # production build into packages/app/dist
npm test -w collection2crate-plugins    # one package's tests
PLUGINS=merge,validate-crate,ro-crate-json-output npm run build   # bundle only some plugins

Extra arguments reach Vite after --, e.g. npm run dev -- --port 3000.

npm install links node_modules/collection2crate-plugins to packages/app-plugins, so an edit to a plugin shows up in the dev server straight away. Add a dependency to one package with npm install <pkg> -w collection2crate or -w collection2crate-plugins.

License

Apache 2.0

Releases

Packages

Contributors

Languages