CenterForDigitalHumanities / CenterForDigitalHumanities/deer

DEER 2.0

Open
#141 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Description

We want to rethink how DEER is coded. In general, the templates we have makes sense for getting someone started. DEER is used to initiate web applications that creates and annotates entities using the RERUM API. It is often used by researchers as a quick way to initiate some web presence for research they are doing.

At present deer uses Javascript Template Literals to define various entity forms. This should change into web components, custom elements, and custom events. We have thought about this before as seen in #96, #118, #119, and #120. We should also consider #125.

Humans and AI assistants should be able to use DEER to quickly generate applications capable of maintaining datasets for their subject matter through RERUM. They should be able to take that use case into DEER and quickly generate a pipeline capable of achieving that goal through DEER. For example...

> I have curated a family photo album and put the photos online. Each photo as its own URI. I want to use DEER to create 'Person' entities for members of my family. I will then Annotate those Person Entities with URIs to photos of them from that family photo album. I also want to include important metadata information: Name, Email (may be multiple), Address (may be multiple), Phone Number (may be multiple), and Description.

A human developer or AI assistant should be able to use DEER to to implement a pipeline that achieves the example use case above. Think about the templates and structure of DEER. Modern development environments should be able to import DEER and implement forms for creating and maintaining data.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current JavaScript Template Literal forms and the discussions in #96, #118, #119, #120, and #125. Define the web-component, custom-element, and custom-event structure needed for the family-photo example, then verify that DEER can generate and maintain the described Person entities and annotations through RERUM.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, web-dev
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.