chrisvanderloo.com / crate
[READ-ONLY] Mirror of https://github.com/chrisvander/crate. The future of cloud storage.
Star 0
Fork 0
Watch
Swift 67%
TypeScript 18%
Rust 14%
Astro <1%
CSS <1%
Just <1%
Dockerfile <1%
<1%
639 1 8
docs
icon
infra
lexicons
packages
scripts
tests
.dockerignore
.env.example
.gitignore
.oxfmtrc.json
.oxlintrc.json
bacon.toml
bun.lock
bunfig.toml
Cargo.lock
Cargo.toml
Justfile
package.json
playwright.config.ts
README.md
tsconfig.base.json
tsconfig.json
README.md
Crate Logo

Crate

Crate is an ATProto-native file application. A permissioned PDS stores file records, version history, and blobs. Astro and Preact provide the web client; a Rust/Poem companion handles browser OAuth and the typed HTTP API.

Development #

Install Just 1.43 or newer, Bun 1.3.13, Node.js 22.12 or newer (for Astro), and Rust 1.95 or newer. Install the pinned Rust development watcher, then start both services:

cargo install --locked bacon --version 3.25.0
just install
just dev

Sign in with your own ATProto handle and approve access on your PDS. The PDS must implement the permissioned Spaces API described in the protocol documentation.

Optional local configuration is listed in .env.example. Just loads root .env for its recipes; direct cargo run uses the process environment. Keep the OAuth data directory private and persistent. It contains credentials and browser sessions, not the authoritative file database.

Run just to list commands, including just infra-preview and just infra-up for the production Pulumi stack (requires the Pulumi CLI and login).

Contract and clients #

Rust record definitions generate root lexicons/network/crate. Actual Poem handlers generate OpenAPI and the TypeScript and Swift clients:

just generate-lexicons  # Lexicons only
just generate-api
just check-contracts

Publish the generated schemas with just publish-lexicons after signing into Goat as the schema publisher. This requires Goat and jq, regenerates the Lexicons, and updates their public records. Use just publish-lexicons create for first publication. It uses Goat's generic record command with --no-validate because goat lex publish does not yet support the alpha Space schema.

Full contract generation/checking requires Swift 6.1 or newer. Generators and their dependencies are pinned. Generated clients are checked in as source, so web builds and root TypeScript checks do not require prebuilding package types. The running Rust server exposes its API documentation at API docs.

Verification and Jujutsu #

just check
just build
jj status
jj diff
jj describe -m 'Describe one completed concept'
jj new

With the stack running, just test-browser checks anonymous behavior and synthetic-account layout and interactions without accessing a real PDS. Install its Chromium browser with bunx playwright install chromium if needed. The authenticated lifecycle is opt-in and requires you to sign in manually:

CRATE_LIVE_PDS=1 just test-browser --grep 'user-authorized private PDS' --headed --workers=1