paddinglabs/margin
1
0
Fork 0
mirror of https://github.com/paddinglabs/margin.git synced 2026-06-19 11:11:14 +00:00
Code Issues Projects Releases Packages Wiki Activity
Official mirror of Margin, an open annotation layer for the internet. Source code is available under AGPL-3.0
338 commits 1 branch 31 tags 14 MiB
  • TypeScript 34.6%
  • JavaScript 25.3%
  • Go 20.9%
  • CSS 12.1%
  • HTML 3.2%
  • Other 3.9%
Find a file
Exact
Scan 86a13b9885
 fix: update GitHub links from margin-at to paddinglabs #58
2026-06-17 10:48:28 -08:00
.github fix build for arm 2026-05-18 05:51:14 -08:00
avatar improvemetns and stuff 2026-04-16 19:48:04 -08:00
backend refactor: db queries, oauth 2026-06-14 03:27:24 -08:00
extension oauth revamp 2026-06-13 18:26:08 -08:00
lexicons/at/margin Analytics, new lexicon, improvements! 2026-04-14 23:07:05 -08:00
web fix: update GitHub links from margin-at to paddinglabs #58 2026-06-17 10:48:28 -08:00
.dockerignore fix dockerfile 2026-02-08 19:35:08 -09:00
.env.example oauth revamp 2026-06-13 18:26:08 -08:00
.gitignore safari 2026-05-25 06:47:01 -08:00
docker-compose.yml oauth revamp 2026-06-13 18:26:08 -08:00
Dockerfile fix build for arm 2026-05-18 05:51:14 -08:00
LICENSE update license to AGPLv3 2026-04-14 23:21:40 -08:00
README.md update readme with translation stuff 2026-04-24 10:33:38 -08:00

README.md

Margin

Write in the margins of the web

A web annotation layer built on AT Protocol that lets you annotate, highlight, and bookmark any URL on the internet.

Project Structure

margin/
├── lexicons/           # AT Protocol lexicon schemas
│   └── at/margin/
│       ├── annotation.json
│       ├── bookmark.json
│       ├── collection.json
│       ├── collectionItem.json
│       ├── highlight.json
│       ├── like.json
│       ├── reply.json
│       ├── apikey.json
│       ├── preferences.json
│       └── profile.json
├── backend/            # Go API server
│   ├── cmd/server/
│   └── internal/
├── web/                # Astro SSR + React web app
│   └── src/
├── extension/          # Browser extension (WXT)
│   └── src/
└── avatar/             # Cloudflare Worker for avatar proxying

Getting Started

Docker (Recommended)

Run the full stack with Docker:

docker compose up -d --build

This builds both the Go backend and the Astro frontend into a single container. The Astro SSR server handles all frontend routing, static assets, and OG image generation, while the Go backend serves the API internally.

Development

Backend

cd backend
go mod tidy
go run ./cmd/server

API server runs on http://localhost:8081

Web App

cd web
bun install
bun run dev

Dev server runs on http://localhost:4321 and proxies API requests to the backend.

Browser Extension

Built with WXT:

cd extension
bun install
bun run dev          # Chrome dev mode
bun run dev:firefox  # Firefox dev mode

Architecture

In production, a single Docker container runs both services:

  • Astro SSR (port 8080, public) — serves the web app, handles SSR for OG meta tags, generates dynamic OG images via satori, and proxies API/auth requests to the backend.
  • Go API (port 8081, internal) — handles all API endpoints, OAuth, firehose ingestion, and data storage.

Domain

Domain: margin.at Lexicon Namespace: at.margin.*

Tech Stack

  • Backend: Go + Chi + SQLite
  • Frontend: Astro 5 (SSR) + React 19 + Tailwind CSS
  • OG Images: satori + @resvg/resvg-js
  • Extension: WXT + React + Tailwind CSS
  • Protocol: AT Protocol (Bluesky)

Sponsors

Thank you for making Margin possible!

Infrastructure Sponsor

Bryan
@chaosgreml.in

GitHub Sponsors

Translations

Help translate Margin at translate.margin.at.

Translation status

License

MIT