22 lines
1 KiB
Markdown
22 lines
1 KiB
Markdown
|
# 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](docs/spec/architecture.md) 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.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cargo build --workspace --locked
|
||
|
|
corepack enable
|
||
|
|
pnpm --dir web install --frozen-lockfile
|
||
|
|
pnpm --dir web build
|
||
|
|
```
|
||
|
|
|
||
|
|
Deployment and verification details are in the [deployment](docs/spec/deployment.md) and [testing](docs/spec/testing.md) documentation.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Remora is licensed under the [Apache License 2.0](LICENSE). See [NOTICE](NOTICE) for the project notice.
|