🚀 Runique - Django-inspired Rust Web Framework

⚠️ Note: This documentation has been generated with AI assistance. While care has been taken to ensure accuracy, some links or details may contain errors. Please report issues on GitHub.

A modern and comprehensive Rust web framework inspired by Django, for building robust and performant web applications.

🌍 Languages : English | 🇫🇷 Français

📚 Table of Contents

• 🚀 Installation
• 🏗️ Architecture
• ⚙️ Configuration
• 🛣️ Routing
• 📝 Forms
• 🎨 Templates
• 🗄️ ORM
• 🔒 Middleware
• 💬 Flash Messages
• 🎓 Examples

🚀 Installation

Full Documentation : Installation Guide

Quick start:

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

👉 Read : docs/en/01-installation.md for complete details

🏗️ Architecture

Full Documentation : Architecture Guide

Overview of Runique's architecture:

Runique Framework
├── Forms System      # Type-safe forms
├── Routing Engine    # URL pattern routing
├── Template Engine   # Tera templates
├── Middleware Stack  # Security & headers
├── ORM Layer         # SeaORM integration
└── Utils             # Helpers and utilities

👉 Read : docs/en/02-architecture.md for internal structure

⚙️ Configuration

Full Documentation : Configuration Guide

Configure your server and application:

let settings = Settings {
    server: ServerConfig { ... },
    database: DatabaseConfig { ... },
    security: SecurityConfig { ... },
};

👉 Read : docs/en/03-configuration.md for all options

🛣️ Routing

Full Documentation : Routing Guide

Define your routes with Axum's Router:

use axum::routing::{get, post};

fn routes() -> Router {
    Router::new()
        .route("/", get(views::home))
        .route("/api/users", post(views::create_user))
}

👉 Read : docs/en/04-routing.md for patterns and options

📝 Forms

Full Documentation : Forms Guide

Create forms easily with #[derive(RuniqueForm)]:

#[derive(RuniqueForm)]
pub struct UserForm {
    #[field(label = "Username", required, min_length = 3)]
    pub username: String,

    #[field(label = "Email", required, input_type = "email")]
    pub email: String,
}

// Handle form submission
async fn register(
    Prisme(mut form): Prisme<UserForm>,
    mut template: TemplateContext,
) -> Response {
    if form.is_valid().await {
        // Process form
    }
    template.context.insert("form", form);
    template.render("register.html")
}

👉 Read : docs/en/05-forms.md for all field types## 🎨 Templates

Full Documentation : Templates Guide

Use Tera templates:

<h1>{{ title }}</h1>
{% for item in items %}
  <p>{{ item }}</p>
{% endfor %}

👉 Read : docs/en/06-templates.md for complete syntax

🗄️ ORM

Full Documentation : ORM Guide

Use SeaORM with Django-like pattern:

impl_objects!(User);

let users = User::objects
    .filter(active.eq(true))
    .all(&db)
    .await?;

👉 Read : docs/en/07-orm.md for advanced queries

🔒 Middleware

Full Documentation : Middleware Guide

Integrated security middleware:

• CSRF Protection
• Content-Security-Policy (CSP)
• Allowed Hosts
• Security Headers
• XSS Sanitizer

👉 Read : docs/en/08-middleware.md for configuration

💬 Flash Messages

Full Documentation : Flash Messages Guide

Temporary messages for users:

success!("Operation successful!");
error!("An error occurred");
warning!("Warning!");

👉 Read : docs/en/09-flash-messages.md for details

🎓 Examples

Full Documentation : Examples Guide

Complete usage examples:

• Complete blog application
• User authentication
• File upload
• REST API

👉 Read : docs/en/10-examples.md for complete examples

🧪 Tests

# Unit tests
cargo test --lib

# Integration tests
cargo test --test integration_tests

# All tests
cargo test --all

Results: 36/36 tests passing ✅

📖 Full Documentation

English (EN)

• Installation
• Architecture
• Configuration
• Routing
• Forms
• Templates
• ORM
• Middleware
• Flash Messages
• Examples

Français (FR)

• Installation
• Architecture
• Configuration
• Routage
• Formulaires
• Templates
• ORM
• Middlewares
• Flash Messages
• Exemples

🎯 Quick Start

1. Read Installation
2. Understand Architecture
3. Check Examples
4. Start coding your application

📊 Project Status

• ✅ Compilation : No errors
• ✅ Tests : 36/36 passing (100%)
• ✅ Documentation : Complete (EN & FR)
• ✅ Production : Ready

See PROJECT_STATUS.md for more details.

🔗 Resources

• 📁 Project Structure
• 📊 Full Status
• 🧪 Test Reports
• 📋 Changelog
• 📖 Documentation Guide

📝 License

MIT License - see SECURITY.md

🚀 Production Ready

The Runique framework is stable, tested and documented, ready for production use.

Start now → Installation

🌍 Available in: English | 🇫🇷 Français