Crate runique 

Runique — Django-inspired Rust Framework

Runique is a web framework built on Axum, focused on type-safe forms, security middleware, template rendering, ORM integration, and a code-generated admin workflow.

Current state: active development. The framework source of truth is the runique crate. demo-app is used as a validation/testing application for framework behavior.

🌍 Languages: English | Français

---

What this repository contains

• runique/ → framework crate (main product)
• demo-app/ → test/validation app for framework development
• docs/ → EN/FR documentation

Workspace version (source of truth): 1.1.40.

---

Core capabilities

• Type-safe form system (forms, extractors, validators, renderers)
• Routing macros and URL helpers
• Tera template integration and context helpers
• Security middleware (CSRF, CSP, allowed hosts, sanitization, auth/session)
• SeaORM integration + migration tooling
• Flash message system
• Admin beta (admin! macro + daemon-generated CRUD code)

Main public modules are exposed from runique/src/lib.rs.

---

Installation

git clone https://github.com/seb-alliot/runique
cd runique
cargo build --workspace
cargo test --workspace

Detailed guide: docs/en/01-installation.md

---

Quick usage

use runique::prelude::*;

#[tokio::main]
async fn main() {
    let config = RuniqueConfig::from_env();
    let app = RuniqueApp::builder(config).build().await.unwrap();
    app.run().await.unwrap();
}

---

CLI (actual commands)

runique provides:

• runique new <name>
• runique start [--main src/main.rs] [--admin src/admin.rs]
• runique create-superuser
• runique makemigrations --entities src/entities --migrations migration/src [--force false]
• runique migration up|down|status --migrations migration/src

⚠️ Warning The makemigrations command generates SeaORM tables while preserving the chronological order of the migration system. To ensure migration tracking remains consistent, only use the SeaORM CLI to apply or manage migrations. Using other commands may lead to migration desynchronization.

Admin daemon behavior in `start`:

- checks whether `.with_admin(...)` exists in `src/main.rs`
- starts the admin watcher when enabled
- otherwise exits with an explicit hint

---

# Admin beta status

Admin resources are declared in `src/admin.rs` using `admin!`.

The workflow:

1. parse `admin!` declarations
2. generate admin code under `src/admins/`
3. refresh on changes with watcher mode

Current beta limits:

- mostly resource-level permissions
- generated folder overwrite (`src/admins/`)
- iterative hardening still in progress

Admin docs: [docs/en/11-Admin.md](docs/en/11-Admin.md)

---

# Features and database backends

Default features:

- `orm`
- `all-databases`

Selectable backends:

- `sqlite`
- `postgres`
- `mysql`
- `mariadb`

---

# Test and coverage snapshot

  - Reported tests: **1523/1523 passing**
  - Coverage snapshot (`2026-03-01`, package `runique`):
  - Functions: **76.66%**
  - Lines: **71.04%**
  - Regions: **67.22%**

Coverage command used:

```bash
cargo llvm-cov --tests --package runique --ignore-filename-regex "admin" --summary-only

See: couverture_test.md

---

Sessions

CleaningMemoryStore replaces the default MemoryStore with automatic expired-session cleanup, a two-tier watermark system (128 MB / 256 MB), and priority-based protection for authenticated and high-value anonymous sessions (shopping carts, multi-step forms).

• Low watermark: background purge of expired anonymous sessions
• High watermark: synchronous emergency purge + 503 refusal if still exceeded
• protect_session(&session, duration_secs) — marks an anonymous session as untouchable until a given timestamp
• user_id key — automatically protects authenticated sessions

Full reference: docs/en/14-sessions.md

---

Environment variables

All behavior is configurable via .env. Key variables:

RUNIQUE_SESSION_CLEANUP_SECS=60
RUNIQUE_SESSION_LOW_WATERMARK=134217728
RUNIQUE_SESSION_HIGH_WATERMARK=268435456
SECRET_KEY=your-secret-key
ALLOWED_HOSTS=localhost,example.com
DATABASE_URL=sqlite://db.sqlite3

Full reference: docs/en/15-env.md

---

Documentation map

English

• Installation
• Architecture
• Configuration
• Routing
• Forms
• Model/Schema
• Templates
• ORM
• Middleware
• Flash Messages
• Examples
• Admin beta
• Sessions
• Environment variables

Français

• Installation
• Architecture
• Configuration
• Routage
• Formulaires
• Model/Schema
• Templates
• ORM
• Middlewares
• Flash Messages
• Exemples
• Admin bêta
• Sessions
• Variables d’environnement

---

Project status

For the detailed, continuously updated state report, see PROJECT_STATUS.md.

---

Resources

• Project structure
• Changelog
• Documentation hub
• Security policy
• Benchmark

---

License

MIT — see LICENCE

Re-exports

pub use forms::Prisme;

pub use anyhow;

pub use argon2;

pub use async_trait;

pub use axum;

pub use chrono;

pub use hmac;

pub use once_cell;

pub use regex;

pub use sea_orm;

pub use serde;

pub use serde_json;

pub use sha2;

pub use tera;

pub use tokio;

pub use tower;

pub use tower_http;

pub use tower_sessions;

pub use uuid;

Modules

admin

app

config

config_runique

context

data_base_runique

db

engine

errors

flash

forms

formulaire

macro_runique

macros

middleware

middleware_runique

migration

moteur_engine

prelude

runique_start

utils

Macros

admin

context

context_update

define_enum_kind

delegate_to_kind

error

flash_now

impl_form_access

impl_from_error

impl_objects

Ajoute un gestionnaire d’objets de style Django à une entité SeaORM.

info

model

success

tpl

tpls

urlpatterns

view

warning