Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-28 00:36:33 +01:00
Code Issues Packages Projects Releases Activity
Files
ce298e477b87a95cd760e0828ce5fb829c74436d
Trilium/docs/Developer Guide/Architecture/README.md
perf3ct 065740eabc feat(docs): completely redo documentation
2025-08-21 15:55:44 +00:00

2.9 KiB
Vendored
Raw Blame History

Trilium Architecture Documentation

This comprehensive guide documents the architecture of Trilium Notes, providing developers with detailed information about the system's core components, data flow, and design patterns.

Table of Contents

  1. Three-Layer Cache System
  2. Entity System
  3. Widget-Based UI Architecture
  4. API Architecture
  5. Monorepo Structure

Overview

Trilium Notes is built as a TypeScript monorepo using NX, featuring a sophisticated architecture that balances performance, flexibility, and maintainability. The system is designed around several key architectural patterns:

  • Three-layer caching system for optimal performance across backend, frontend, and shared content
  • Entity-based data model supporting hierarchical note structures with multiple parent relationships
  • Widget-based UI architecture enabling modular and extensible interface components
  • Multiple API layers for internal operations, external integrations, and real-time synchronization
  • Monorepo structure facilitating code sharing and consistent development patterns

Quick Start for Developers

If you're new to Trilium development, start with these sections:

  1. Monorepo Structure - Understand the project organization
  2. Entity System - Learn about the core data model
  3. Three-Layer Cache System - Understand data flow and caching

For UI development, refer to:

For API integration, see:

Architecture Principles

Performance First

  • Lazy loading of note content
  • Efficient caching at multiple layers
  • Optimized database queries with prepared statements

Flexibility

  • Support for multiple note types
  • Extensible through scripting
  • Plugin architecture for UI widgets

Data Integrity

  • Transactional database operations
  • Revision history for all changes
  • Synchronization conflict resolution

Security

  • Per-note encryption
  • Protected sessions
  • API authentication tokens

Development Workflow

  1. Setup Development Environment

    pnpm install
pnpm run server:start

  2. Make Changes

    • Backend changes in apps/server/src/
    • Frontend changes in apps/client/src/
    • Shared code in packages/

  3. Test Your Changes

    pnpm test:all
pnpm nx run <project>:lint

  4. Build for Production

    pnpm nx build server
pnpm nx build client

Further Reading