[READ-ONLY] Mirror of https://github.com/flo-bit/contrail. atproto backend in a bottle flo-bit.dev/contrail
TypeScript 99%
JavaScript <1%
Svelte <1%
HTML <1%
<1%
CSS <1%

README.md

Contrail #

Pre-alpha. Expect breaking changes.

Contrail turns public AT Protocol records into a queryable AppView.

It provides:

  • historical backfill from relays and PDSes;
  • current updates from Jetstream;
  • D1, SQLite, and PostgreSQL storage;
  • getRecord and listRecords HTTP endpoints;
  • filters, sorting, search, and pagination;
  • custom queries;
  • relationship counts and hydration; and
  • profile and label hydration.

Cloudflare Workers with D1 is the primary deployment target. Node.js with SQLite or PostgreSQL is also supported.

Documentation #

  1. Get started locally
  2. Add the typed client
  3. Configure and query
  4. Deploy to Cloudflare Workers