Developer guide

This guide covers the technical architecture and implementation details of Chive. It's intended for developers who want to contribute to the project or understand how the system works.

Architecture overview

Chive is an AT Protocol AppView that indexes scholarly eprints from the decentralized network. The system consists of:

Key principles

AT Protocol compliance

Chive is a read-only indexer. All user content lives in Personal Data Servers (PDSes). The golden rules:

• Read from the firehose, never write to user PDSes
• Store BlobRefs (CID pointers), never blob data
• All indexes must be rebuildable from the firehose
• Track PDS source for staleness detection

Modular architecture

Services use dependency injection via TSyringe. All major components implement interfaces with I* prefix:

interface ISearchEngine {
  indexEprint(doc: IndexableEprintDocument): Promise<void>;
  search(query: SearchQuery): Promise<SearchResults>;
}

Plugin system

Plugins extend functionality through a hybrid DI + EventEmitter2 architecture. Plugins run in isolated-vm sandboxes with declared permissions.

Guide sections

Section	Description
API layer	XRPC and REST endpoint implementation
Authentication	OAuth, sessions, and authorization
Core services	Business logic services
Lexicon type validation	Generated types and runtime validation
Frontend	Next.js architecture and components
Frontend rich text	Rich text rendering and schema migrations
Frontend eprint lifecycle	Edit, version, and delete components
Plugin system	Creating and managing plugins
Advanced features	Knowledge graph, discovery, and more
Observability	Logging, metrics, and tracing

Subdirectories

Directory	Description
plugins/	Plugin development guides and reference
services/	Individual service documentation
storage/	Database adapter documentation

Technology stack

Layer	Technology
Runtime	Node.js 22+
Language	TypeScript 5.5+
API	Hono (XRPC + REST)
Frontend	Next.js 15, React 19
Primary database	PostgreSQL 16+
Search	Elasticsearch 8+
Graph database	Neo4j 5+
Cache	Redis 7+
Testing	Vitest, Playwright

Development setup

# Clone and install
git clone https://github.com/chive-pub/chive.git
cd chive
pnpm install

# Start infrastructure
./scripts/start-test-stack.sh

# Run development server
pnpm dev

# Run tests
pnpm test

Directory structure

src/
├── api/           # Hono XRPC + REST handlers
├── atproto/       # AT Protocol client, firehose consumer
├── auth/          # Authentication and authorization
├── config/        # Configuration loading
├── jobs/          # Background job definitions
├── lexicons/      # Generated lexicon types
├── observability/ # Logging, metrics, tracing
├── plugins/       # Plugin system and builtins
├── services/      # Business logic services
├── storage/       # Database adapters
├── types/         # TypeScript type definitions
├── utils/         # Utility functions
└── workers/       # Worker threads

Next steps

Start with API layer to understand how requests are handled, then explore Core services for the business logic.