StackRivet Documentation
StackRivet is an AI-native Java enterprise app platform for Spring Boot and Vue teams. You generate governed business modules instead of loose CRUD, and your AI coding tools work inside the project’s architecture, security and testing rules.
These docs cover the Community edition: the Apache-2.0, commercial-friendly base you can use in real projects.
Start here
Section titled “Start here”New to StackRivet? Get the backend and its OpenAPI explorer running locally first:
➡️ Quick Start — run StackRivet in a few minutes.
What you get
Section titled “What you get”| Area | Included |
|---|---|
| Backend | Spring Boot 4.0.6 modular monolith (16 Maven modules), Spring Security, MyBatis-Plus, Flyway |
| Frontend | Vue 3.5, TypeScript 6, Vite 8, Element Plus 2.14 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-compatible and Aliyun OSS storage, signed URLs, multipart upload |
| 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 |
How these docs are organized
Section titled “How these docs are organized”- Getting Started — install StackRivet, understand the repositories, and run your first module.
- Concepts — the architecture, security model, Asset Service, async tasks and AI guardrails.
- Guides — task-focused walkthroughs: generate a module, add a permission, configure storage, deploy.
- Reference — API conventions, the CLI, configuration, the database schema and engineering standards.
- Contributing — how to propose changes, pass review gates, and understand the project license.
Edition boundary
Section titled “Edition boundary”StackRivet is open core. The Community edition documented here is free and commercial-friendly under Apache-2.0. Pro and Enterprise features (SSO, multitenancy, advanced storage, workflow, private deployment and support) are noted where relevant and detailed on the pricing page.