Skip to main content

​
Getting Started

Welcome to Chronicle! This guide will help you get up and running.

​
Prerequisites

  • Node.js 20+
  • pnpm
  • Rust 1.75+ (for relay service)

​
Quick Start

​
1. Clone the repositories

git clone https://github.com/chronicle-hq/app.git
git clone https://github.com/chronicle-hq/relay.git

​
2. Start the relay service

cd relay
cargo run
The relay will start on http://localhost:8080.

​
3. Start the web app

cd app
pnpm install
pnpm dev
The app will be available at http://localhost:3000.

​
Architecture Overview

┌─────────────────┐     ┌─────────────────┐
│   Chronicle     │     │   Chronicle     │
│      App        │────▶│     Relay       │
│   (Next.js)     │ WS  │  (Rust/Axum)    │
└─────────────────┘     └────────┬────────┘
                                 │
         ┌───────────────────────┼───────────────────────┐
         │                       │                       │
    ┌────▼────┐             ┌────▼────┐             ┌────▼────┐
    │fork-node│             │vest-node│             │tnp-node │
    │  CRDT   │             │  Audit  │             │Temporal │
    └─────────┘             └─────────┘             └─────────┘

​
Next Steps