Welcome to CARE!

Welcome to the CARE project – contribute towards AI-assisted collaborative reading.

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 is developed at the UKP Lab at the TU Darmstadt as part of the Intertext Initiative.

Getting Started

• Quickstart
• Installation

For Developers

• Before You Start
  • Software Prerequisites
  • Customizing Builds
  • Development Build
  • Deployment Build
  • More Commands
• Basics
  • Conventions and Paradigms
  • Frameworks
• Frontend Development
  • Base Components
  • Coordinator
  • Dashboard
  • Quill Editor
  • NLPService
  • Settings
  • User Statistics
  • Table
  • Toast Messages
  • Vuex Store
• Backend Development
  • Database
  • Logging
  • Right Management
  • RPC Service
  • Services
  • Sockets
  • Tests
  • Moodle API
• Examples
  • 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
• Exporting Data
  • Exporting Inline Commentary
• Studies
  • Study Deployment
  • Revision Workflow Study Example
• Moodle API
  • Overview
  • Setting Up the Moodle API
  • Setting Up the Moodle Integration in CARE
  • Assignment Configuration in Moodle
  • Further Reading

Indices and tables

• Index

• Module Index

• Search Page