Welcome to CARE!

Welcome to the CARE project – a Collaborative AI-Assisted Research Environment for reading, annotating, writing, and assessment workflows.

This documentation covers many examples to get you started really quick – both as a developer contributing to the extension of CARE or as a researcher using it for your research.

The project originated from the Intertext Initiative at the UKP Lab, TU Darmstadt, and is supported by the ATHENE Center, DFG, and the European Union.

For a live demo, visit https://demo.care.ukp.informatik.tu-darmstadt.de. Join our Discord to reach the team directly or discuss the project with the community.

Getting Started

• Quickstart
• Installation

For Developers

• Before You Start
  • Software Prerequisites
  • Customizing Builds
  • Development Build
  • Deployment Build
  • More Commands
• Basics
  • Conventions and Paradigms
  • Frameworks
  • User Stories
• Frontend Development
  • Basic
  • Components
  • Plugins
  • Vuex Store
  • User Statistics
• Backend Development
  • Anonymized Database Dump
  • Data Transfer
  • Database
  • Logging
  • Right Management
  • RPC Service
  • Services
  • Sockets
  • Tests
  • Validation
  • Moodle API
• Examples
  • Settings
  • Data Table
• Debugging
  • General
  • Browser Developer Tools
  • Stopping open processes
  • Importing a Production Database Locally

For Researchers

• Basics
  • Hosting CARE for Your Study
  • Trouble Shooting
  • Research with CARE
• NLP Model Debugging
• Applying NLP Skills to Documents
  • When to Use Skill Application
  • Accessing Skill Application
  • Configuration Steps
  • Step 4: Select Base Files (submission-based parameter selections only)
  • Monitoring and Results
  • Error Handling
  • Best Practices
  • Troubleshooting
• Exporting Data
  • Exporting Inline Commentary
• Studies
  • What is a Study?
  • Study Deployment
  • Revision Workflow Study Example
• Quill Editor
  • Overview
  • Accessing the Editor
  • Editor Settings
  • Viewing Edit History
• Workflow Management
  • Workflow Dashboard
  • Workflow Creation
  • Workflow Steps Management
• Email and Document Templates
  • When to Use Which Template Type
  • Flow to Create and Use a Template
  • Checkboxes So Emails Actually Get Sent
  • Where Templates Are Used
  • Publishing and Deletion
  • Update-from-Source for Copies
  • Errors and Placeholders Not Replaced
• Validation Schemas
  • Overview
  • Creating a Validation Schema
  • Example: PDF Only Validation
  • Example: PDF + LaTeX ZIP Validation
  • Uploading Validation Schemas
  • Validation Behavior
  • See Also
• Moodle API
  • Overview
  • Setting Up the Moodle API
  • Setting Up the Moodle Integration in CARE
  • Assignment Configuration in Moodle
  • Further Reading

History of the project

• Information About the Project

Indices and tables

• Index

• Module Index

• Search Page