ch-rds 0.1.1

Runtime resource loading and local service orchestration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# ch-rds

`ch-rds` resolves runtime resources and starts conventional local services when
an application uses loopback endpoints.

More information is available in the [API documentation](https://docs.rs/ch-rds).

## High-level features

- Typed loaders for web listeners, MariaDB, and SpacetimeDB
- Explicit production behavior with no local fallback
- Conventional `.env`, `.env.local`, and `services.env` discovery
- Protocol-verified local Docker Compose startup for loopback resources
- Optional frontend/backend development process orchestration

## Usage

```rust,no_run
#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let runtime = ch_rds::Runtime::bootstrap()?;
    let bind_addr = runtime
        .load(ch_rds::WebBind::builder().addr("127.0.0.1:8080"))
        .await?;

    println!("{bind_addr}");
    Ok(())
}
```

`Runtime` resolves configured remote endpoints directly. Production mode
rejects local fallbacks. `ENV_FILE` selects one explicit dotenv file, while
`PORT` overrides only the port of the fallback listener address.

For conventional layouts, MariaDB discovers `services.env` in the project root
and derives the Compose project name from `app/Cargo.toml`. A SpacetimeDB module
under `crates/database/spacetimedb` is detected from its Cargo package name.
Builders remain available for nonstandard names, paths, ports, and local stacks.
Local MariaDB readiness uses a real authenticated query, while SpacetimeDB uses
its documented `/v1/ping` endpoint. A broken local service is restarted at most
once under the shared lifecycle lock. SpacetimeDB source changes are published
into the existing database so its data and server-issued owner identity remain
durable across editor rebuilds.

## Development runner

The `dev` feature provides `ProjectProfile` and `run_project`. Vite owns frontend
hot-module replacement; Watchexec restarts the backend when Rust sources,
manifests, lockfiles, Cargo configuration, or SQL migrations change.

```console
cargo install watchexec-cli --version 2.5.1 --locked
```

## Feature flags

| Feature | Provides |
| --- | --- |
| `dev` | Frontend/backend process orchestration and project profiles |
| `btcpay` | Local BTCPay setup in addition to `dev` |

## Minimum supported Rust version

`ch-rds` requires Rust 1.96 or newer.

## License

Licensed under the Sustainable Use License 1.0. See
[`LICENSE.md`](LICENSE.md).