StackRivet Documentation
StackRivet is a Spring Boot and Vue application base built for AI coding teams. Its generator previews and produces governed backend, admin UI, permission, migration and test scaffolding, while Claude Code, Cursor and Codex work inside the project’s architecture, security and testing rules.
These docs are the free, Apache-2.0 Community edition. New here? Follow the five steps below in order — you’ll have it running and generate your first module in about an hour.
Your first hour
Section titled “Your first hour”-
Run it locally — start the data stores, run the backend and the admin UI, then log in. → Quick Start
-
See what it does — use the fresh-local-database seed account documented in Quick Start, click through the modules that ship in the box, and fetch the authenticated OpenAPI catalog when you need endpoint details. Hosted-demo access is separate and shown on its sign-in page.
-
Generate and land your first module — use the in-product generator to create a reviewable backend/frontend module bundle, then follow the manual landing guide to wire Maven, Flyway, Vue routes and RBAC menus. → Generate a Module and Land Generated Code
-
Deploy a minimal app — build the backend jar and the static admin bundle, set the required environment variables, then run the release artifacts. → Deployment
-
Go deeper — once it runs, learn the architecture, security model and AI guardrails. → Concepts
First time? Start at step 1 and don’t skip ahead — each step builds on the last. Already know Spring Boot + Vue? Jump straight to Generate a Module.
What’s in the box
Section titled “What’s in the box”Once you’re running, this is the full feature set (use it as a reference, not a starting point):
| Area | Included |
|---|---|
| Backend | Spring Boot 4.0 modular monolith (16 Maven modules), Spring Security, MyBatis-Plus, Flyway |
| Frontend | Vue 3.5, TypeScript, Vite, Element Plus with the StackRivet design system |
| Access control | RBAC, menu / button / API permissions, row-level data permissions |
| Code generation | Entity, Mapper, Service, Controller, DTO/VO, frontend pages, OpenAPI and test scaffolding |
| Asset Service | Local/S3/OSS, private signed downloads; transit by default, byte-bound S3 direct/multipart only when advertised |
| Observability | traceId, Actuator, Micrometer, optional OpenTelemetry profile |
| AI engineering | AI-readable rules, module boundaries and generated context for Codex, Cursor and Claude Code |
| Delivery | Docker Compose, Dev Container, CLI doctor, SBOM and release checklist |
Map of the docs
Section titled “Map of the docs”- Getting Started — run it, understand the repositories, generate your first module.
- Concepts — the architecture, security model, Asset Service, async tasks and AI guardrails.
- Guides — task-focused walkthroughs: generate a module, land generated code, add a permission, configure storage, deploy.
- Reference — API conventions, the CLI, configuration, the database schema and engineering standards.
Editions
Section titled “Editions”StackRivet is open core. This Community edition is generally available and commercial-friendly under Apache-2.0. Team and Enterprise are currently scoped design-partner pilots; roadmap and contracted capabilities are labeled on the pricing page.