Skip to content

Latest commit

 

History

History
82 lines (64 loc) · 3.6 KB

File metadata and controls

82 lines (64 loc) · 3.6 KB

Suprnova Manual

The complete user manual for Suprnova, a Laravel-inspired web framework for Rust.

Start here: documentation.md - the master table of contents organised the way Laravel's docs are, so if you know your way around those, you'll feel at home.


Languages

The manual ships in six languages besides English, each a complete translation of all 105 chapters plus the table of contents and the changelog. English is canonical - structure, code, identifiers and commands are byte-identical across languages; only the prose differs.

Language Directory
Español es/
Français fr/
Deutsch de/
Português (Brasil) pt-BR/
日本語 ja/
简体中文 zh-Hans/

The translations are produced and reviewed for suprnova.app, which renders this manual as its /docs and keeps the per-section review ledger and terminology glossaries. Corrections are welcome in either repo.


I want to…

Goal Read this
Understand what Suprnova is Introduction
Migrate from Laravel From Laravel
Compare to Axum / Actix / Rocket From Rust Web
Install and scaffold a project Installation
Build a small app end-to-end Quickstart
Understand how a request flows Request Lifecycle
Find an API I remember from Laravel Laravel Parity Map
Look up an env var Environment Variables
Deploy to production Deployment
Use named HTTPS dev URLs (passkeys, secure cookies) HTTPS Dev URLs
Add social login or Sign in with Apple OAuth & Passwordless Login

Two reading paths

The manual has two intro tracks. Pick the one that matches your background; both converge on the shared chapters from "The Basics" onward.

  • From Laravel → for PHP developers used to routes, Eloquent, Auth::user(), php artisan, Mailable, queues, and Blade. We translate every habit you have into the Suprnova equivalent.
  • From Rust Web → for Rust developers familiar with Axum, Actix, or Rocket who want a full-stack productivity layer with codegen, an Eloquent-style ORM, and an Inertia bridge to the frontend.

How this manual is organised

documentation.md mirrors the Laravel docs index: a single master table of contents grouped into Prologue, Getting Started, Architecture Concepts, The Basics, Digging Deeper, Security, Database, Eloquent ORM, Testing, Payments, Frontend, CLI, Deployment, Tutorials, and Reference. Every chapter is one markdown file at the root of manual/. Files render directly on github.com - no build step, no SaaS dependency.

A note on completeness

Every public subsystem in framework/src/ has a chapter. Every chapter is validated against the actual code at the HEAD it was written against. Where we differ from Laravel - usually because Rust gives us something better (concurrency primitives, type-safe macros, async-everywhere) - the chapter calls it out explicitly with a "Why Suprnova diverges" callout. We do not silently break Laravel parity without saying so.

If a chapter says an API exists and you can't find it, that's a bug - please open an issue.