A premium, local-first, distraction-free writing environment. Inspired by the simplicity of blank.page but engineered with a modern Go sync backend, dynamic audio synthesis, GitHub-style Markdown rendering, and strict privacy controls.

Traditional writing apps are bloated with formatting tools, cluttered sidebars, telemetry trackers, and forced cloud dependencies that break when offline.

Minimal Write fixes these friction points:

• Zero Distractions: The user interface (menus, toolbar, sidebars) fades away entirely as you type, leaving only your text.
• Privacy & Local-First: Your data is yours. It is stored on-device in localStorage by default. There is no telemetry, tracking, or unsolicited cookies.
• Offline Reliability: Write anywhere, with or without internet. When you connect, updates sync seamlessly.
• Secure Cloud Backup: Opt-in delta sync backup to a private Go server.
• Immersive Writing: Typewriter audio synthesis provides tactile feedback, helping you find your creative flow.

Minimal Write adapts to your style, monitor, and writing preferences:

You can spin up the complete ecosystem (both frontend and backend) in less than a minute.

This compiles the Go binary, builds the React assets, and serves them via an optimized Nginx server.

# 1. Start the containers
docker-compose up --build -d

# 2. Check that everything is running
docker-compose ps

• Web UI Client: Open http://localhost:80
• Go API Engine: Access endpoints at http://localhost:8080/api
• Persistent Data: SQLite database is stored in the Docker volume backend-data.

• Go 1.21+
• Node.js 20+

cd backend

# Fetch and cache dependencies
go mod tidy

# Run migrations and start the server
go run .

cd frontend

# Install package dependencies
npm install

# Start the Vite development server
npm run dev

• Open your browser to http://localhost:5173.
• Toggle settings, type text, turn on typewriter sounds, and connect to sync!

flowchart TB
    %% Client Browser
    subgraph Client [Browser - React + Vite + TypeScript]
        UI[Editor Canvas]
        Audio[Web Audio Click Synthesizer]
        Exporter[HTML / MD / PDF Exporter]
        Cache[(Local Storage)]
        SyncAPI[Sync Client]
        
        UI -->|Play Keystroke| Audio
        UI -->|Save File / Print| Exporter
        UI -->|Autosave| Cache
        UI -->|Sync Trigger| SyncAPI
    end

    %% Network Boundary
    SyncAPI <==>|REST JSON / JWT Token| Gateway[Go API Server]

    %% Backend Server
    subgraph Go_Backend [Go Service Engine]
        Gateway --> CORS[CORS & Logger Middleware]
        CORS --> AuthFilter[JWT Auth Filter]
        AuthFilter --> Handlers[Auth & Sync Handlers]
        Handlers <--> DB[(SQLite Database)]
    end

The backend uses a lightweight SQLite schema optimized with indexes for query speeds.

Stores credentials for secure delta sync authentication.

CREATE TABLE IF NOT EXISTS users (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    username TEXT UNIQUE NOT NULL,
    password_hash TEXT NOT NULL,
    created_at INTEGER NOT NULL
);

Stores user documents with soft-delete tombstones for multi-device sync integrity.

CREATE TABLE IF NOT EXISTS documents (
    id TEXT PRIMARY KEY,
    user_id INTEGER NOT NULL,
    title TEXT NOT NULL,
    content TEXT NOT NULL,
    updated_at INTEGER NOT NULL,
    created_at INTEGER NOT NULL,
    is_deleted INTEGER DEFAULT 0,
    share_id TEXT UNIQUE,
    FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);

Minimal Write uses a client-side Last-Write-Wins (LWW) conflict resolution algorithm:

1. Timestamps: Each document contains an updated_at millisecond Unix timestamp.
2. Client Push: When a client triggers a sync, it POSTs its array of modified documents along with a last_sync_time parameter.
3. Server Merge:
   • If the server has no record for the document ID, it inserts the document.
   • If the server has a record, it compares timestamps:
     • If client.updated_at > server.updated_at, the server's record is overwritten.
     • If client.updated_at <= server.updated_at, the server's record is preserved.
4. Server Pull: The server queries the database for all records belonging to the authenticated user where updated_at > client_last_sync_time.
5. Tombstoning: Deleting a file toggles is_deleted = 1 and bumps updated_at. When synced, the server records the deletion, and other clients purge the file on their next sync cycle.

All request and response payloads communicate using standard JSON. Protected endpoints require a Bearer <JWT_TOKEN> header.

• URL: /api/auth/signup
• Method: POST
• Payload:

  {
    "username": "writer1",
    "password": "securepassword123"
  }

• Response (200 OK):

  {
    "token": "eyJhbGciOiJIUzI1NiIsIn...",
    "user": { "id": 1, "username": "writer1" }
  }

• URL: /api/auth/login
• Method: POST
• Payload: Same as Signup.
• Response (200 OK): Same as Signup.

• URL: /api/sync?last_sync_time=1719948000000
• Method: POST
• Payload:

  {
    "documents": [
      {
        "id": "uuid-1234-5678",
        "title": "My Novel",
        "content": "Once upon a time...",
        "updated_at": 1720000000000,
        "created_at": 1720000000000,
        "is_deleted": false
      }
    ]
  }

• Response (200 OK):

  {
    "updates": [
      {
        "id": "uuid-9999-0000",
        "title": "Poetry Collection",
        "content": "Roses are red...",
        "updated_at": 1720000100000,
        "created_at": 1720000100000,
        "is_deleted": false,
        "share_id": ""
      }
    ],
    "server_time": 1720000200000
  }

• URL: /api/share
• Method: POST
• Payload:

  {
    "document_id": "uuid-1234-5678",
    "share": true
  }

• Response (200 OK):

  {
    "share_id": "abcde12345fghij"
  }

• URL: /api/shared?share_id=abcde12345fghij
• Method: GET
• Response (200 OK):

  {
    "id": "uuid-1234-5678",
    "title": "My Novel",
    "content": "Once upon a time...",
    "updated_at": 1720000000000,
    "created_at": 1720000000000
  }

Press these hotkeys inside the editor canvas to trigger panel toggles and styling commands:

Copy and paste this markdown text block into the editor canvas to check the GitHub-style layout rendering:

# Header 1 (Title)
## Header 2 (Subtitle)

This is a paragraph featuring **bold text**, *italic emphasis*, and ~~strikethrough text~~.

### Blockquotes
> "Writing is an exploration. You start from nothing and learn as you go."
> — E.L. Doctorow

### Code Highlights
You can write inline code like `const active = true;` or create multiline code blocks:

```javascript
function greet(user) {
  console.log(`Hello, ${user}!`);
}
greet("Writer");

---

## 🧪 Tests & Quality Assurance

### Go Backend Integration Tests
Tests are executed on an in-memory SQLite database instance. They verify registration, password hash comparison, duplicates rejection, and access tokens.

```bash
cd backend
go test -v ./...

Expected output:

=== RUN   TestSignupAndLoginFlow
--- PASS: TestSignupAndLoginFlow (0.73s)
PASS
ok  	backend	0.736s

Runs TypeScript compilation and Vite bundler to test production builds:

cd frontend
npm run build

1. Commit Convention: Commit frequently with clear, descriptive, and atomic messages.
2. Formatting Standards:
   • Go: run go fmt ./... before committing.
   • Frontend: Code must pass strictly in TypeScript strict mode. Run npm run build to verify bundles.
3. Testing: When editing handlers, update backend/main_test.go to maintain 100% test pass.