remora/README.md

1 KiB

Remora

Remora is a multi-user service that runs durable download jobs from HTTP, S3-compatible object stores, and Hugging Face repositories into S3-compatible object storage. It provides a browser interface and API backed by stateless API and worker services.

Remora is early in development. Interfaces, deployment behavior, and compatibility may change, so evaluate it carefully before relying on it. The architecture specification describes the current design.

Build

Use the Rust and Node.js versions pinned by rust-toolchain.toml and .node-version. Enable Corepack so the package manager version declared by the web workspace is used.

cargo build --workspace --locked
corepack enable
pnpm --dir web install --frozen-lockfile
pnpm --dir web build

Deployment and verification details are in the deployment and testing documentation.

License

Remora is licensed under the Apache License 2.0. See NOTICE for the project notice.