Development Setup
Simplified setup for development and testing purposes.
Getting Started
Recogito Studio is a modern, open-source platform for collaborative annotation of TEI text, IIIF images, and PDFs. This documentation covers everything you need to run Recogito Studio locally or self-host your own instance.
Local Development Setup & Self-Hosting
Section titled “Local Development Setup & Self-Hosting”Choose one of the following guides to set up your own instance:
Complete Installation
Full Docker-based deployment with all services included. Perfect for production environments.
Architecture Overview
Section titled “Architecture Overview”Recogito Studio consists primarily of two integrated components:
- recogito-client (Astro.js + Vite) - Client web application
- recogito-server (Supabase + PostgreSQL) - Database backend and file storage
It also offers extended functionality through plugins, and an SDK for developing plugins.
Plugins
Section titled “Plugins”Recogito Studio offers extended functionality through a plugin architecture. The following plugins are currently available:
- GeoTagger – Tag annotations with geographical references from a gazetteer.
- Reconciliation Service API – Use a Reconciliation Service API endpoint as a tag source in your projects.
- NER Plugin – Automatically perform Named Entity Recognition on plain text and TEI documents.
- Revisions Plugin – Basic annotation revision functionality.
- TEI Inliner Plugin – Export TEI annotations as inline markup.
- Sandcastle3D Export – Custom annotation export for the Sandcastle project.
For information on installing plugins, visit the Plugins Guide →.
Interested in developing a plugin yourself? Visit the Plugin Development Guide →.
Need Help?
Section titled “Need Help?”- Community: Join the Recogito Forum
- Source Code: Visit the GitHub repository
- Commercial Support: Contact Performant Software