royalty 0.1.1

Ecosystem of libraries and tools designed to bring both performance and productivity to backend development, AI systems, data engineering, and distributed systems in Rust
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

# Royalty (`royalty`)

**The core library of the Royalty ecosystem.**

Part of [Royalty](https://github.com/king-swordmaster/Royalty) — an ecosystem of libraries and tools designed to bring both **performance** and **productivity** to backend development, AI systems, data engineering, and distributed systems in Rust.

This library provides batteries-included utilities built on [Axum](https://github.com/tokio-rs/axum) and [SeaORM](https://github.com/SeaQL/sea-orm), letting you focus on business logic instead of boilerplate.

## Features

- **Server Setup**: Pre-configured Axum server with tracing
- **Database**: SeaORM integration with PostgreSQL and connection pooling
- **Migrations**: Automatic database migration support via SeaORM
- **Configuration**: Environment-based configuration with sensible defaults
- **Tracing**: Built-in structured logging with `tracing`

### Roadmap

- 🤖 AI/ML integration primitives
- 📨 Event-driven architecture (message queues, pub/sub)
- ⚙️ Background jobs and workers
- 🔌 gRPC support
- ☁️ Cloud storage integrations (S3, GCP Storage, Azure Blob)
- 📊 Observability and metrics
- 🔐 Authentication and authorization primitives
- 🔄 Distributed systems patterns

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
royalty = "0.1"
```

## Quick Start

```rust
use royalty::{server::run_with_migrator, FrameworkContext};
use axum::{Router, routing::get};

// Your migrator (from sea-orm-migration)
struct Migrator;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    dotenvy::dotenv().ok();
    royalty::tracing::init_tracing();

    run_with_migrator::<Migrator, _>(build_router, true).await
}

fn build_router(ctx: &FrameworkContext) -> Router {
    Router::new()
        .route("/health", get(|| async { "OK" }))
        .with_state(ctx.clone())
}
```

## Configuration

The framework reads configuration from environment variables:

| Variable             | Description                       | Default                       |
| -------------------- | --------------------------------- | ----------------------------- |
| `DATABASE_URL`       | PostgreSQL connection string      | **Required**                  |
| `APP_HOST`           | Server bind host                  | `0.0.0.0`                     |
| `APP_PORT`           | Server bind port                  | `3000`                        |
| `RUST_LOG`           | Log level filter                  | `info,sqlx=warn,sea_orm=info` |
| `DB_MAX_CONNECTIONS` | Maximum database connections      | `100`                         |
| `DB_MIN_CONNECTIONS` | Minimum database connections      | `5`                           |
| `DB_CONNECT_TIMEOUT` | Connection timeout (seconds)      | `8`                           |
| `DB_IDLE_TIMEOUT`    | Idle connection timeout (seconds) | `600`                         |
| `DB_MAX_LIFETIME`    | Max connection lifetime (seconds) | `1800`                        |

## Modules

- **`config`** - Application configuration from environment variables
- **`db`** - Database connection with SeaORM
- **`server`** - Axum server setup and execution
- **`tracing`** - Structured logging initialization

## CLI Tool

For quickly scaffolding new projects, download the Royalty CLI from [GitHub Releases](https://github.com/king-swordmaster/Royalty/releases):

```bash
royalty new my-api
```

See the main [repository](https://github.com/king-swordmaster/Royalty) for installation instructions.

## License

MIT