@arpproject/crate-builder-component

Note

For the main Describo project visit: https://www.npmjs.com/package/@describo/crate-builder-component

This is a fork of the Crate Builder Component for use in the ARP project. Contains additions and modifications necessary for the ARP project that are not present/required/supported by the original component. We, however, try to keep compatibilioty with the original project as much as possible and update to its new version.

The package version matches the latest version of the original Crate Builder project (eg. 0.80.0) and an additional -arp.X marks the patch version for ARP. For example, 0.80.0-arp.12 is based on the 0.80.0 version of the Crate Builder Component and is the 12th patched version of it for use in ARP.

Crate Builder Component

• Crate Builder Component
• Documentation
• API Documentation
• Developing the plugin
  • Storybook
  • Development application
• Building and publishing a release
• Building and publishing API docs - has to be separate stage
• Repository structure

This is the core UI component for assembling an RO-Crate inside Describo. It is a self contained VueJS component that can be used inside your app. If you use this component, your app is responsible for loading the crate file from the storage layer (or minting a new one if none exists) and saving the updated crate back. Your app can also provide a profile to the component and a class to handle template lookups.

Documentation

Comprehensive documentation is available @ https://describo.github.io/docs/component/introduction.html

API Documentation

• CrateManager
• ProfileManager
• EditorState

Developing the plugin

Storybook

Storybook is used in this application. When you are just developing the components, storybook is what you want as you can focus just on the component in isolation. To start it run:

npm run storybook

Development application

When you want to see the component in action as a whole, there is a small VueJS app in this codebase. To start up the dev environment:

> docker compose up (starts up an elastic search container for datapack lookups)
> npm run develop

--> browse to localhost:9000

Building and publishing a release

• npm run build: This builds the plugin and styles that the react component uses
• npm version {minor|patch}
• git push origin master --tags
• Go to the repo and create a release from the tag, documenting what is in it.
• Publish to npm: npm publish
• Create an issue in the React component issue tracker to inform that a new release of that component needs to be built and published to npm.

Building and publishing API docs - has to be separate stage

• npm run docs: Update the jsdoc documentation
• git add . && git commit -a
• git push origin master --tags

Repository structure

• The development app is at ./src/app. In there you will find the file main.js where we import the plugin and wire it into Vue as well as an App.vue file where we load the component.
• The component is at ./src/crate-builder.