ch-rds 0.2.0

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

# ch-rds

Runtime setup and local development tools for Rust apps.

## Installation

```toml
[dependencies]
ch-rds = "0.2.0"
```

Requires Rust 1.99 or newer.

## Usage

`Runtime::bootstrap` finds the project and loads its environment files.
`Runtime::load` resolves web listener addresses, MariaDB connection URLs, and
SpacetimeDB connections.

Local connections can start the project's Docker Compose services.
Configure database connections explicitly in production.

Set `ENV_FILE` to choose an environment file. `PORT` overrides the web listener
port. `CronjobManager` runs background jobs at regular intervals.

## Features

| Feature | Includes |
| --- | --- |
| `dev` | Frontend and backend commands through `ProjectProfile` and `run_project` |
| `btcpay` | Local BTCPay setup and the `dev` feature |

The development runner provides `watch`, `build`, and `serve` commands.
Watch mode requires [watchexec](https://watchexec.github.io/).

See the [API documentation](https://docs.rs/ch-rds) for configuration options.

## License

[Sustainable Use License 1.0](LICENSE.md).