Skip to content

Repository files navigation

VAdmin

English | 简体中文

VAdmin is a Java-first administration baseline for Vaadin Flow. Its reusable core — identity and permission contracts, RBAC use cases, and the shared shell patterns — is framework-neutral, and runtime-specific behavior lives in adapter modules, so runtimes beyond Spring Boot (such as Quarkus, Helidon, or Jakarta EE) remain possible future adapters. Spring Boot is the only supported runtime today: add vadmin-spring-boot-starter to receive local login, permission-filtered navigation, the default shell and theme, Users, Roles, Permissions, Audit, locale selection, and appearance controls. It is not a collection of showcase pages or a runtime plugin platform.

The first release uses Java 25, Maven 4.0.0-rc-6, Spring Boot 4.1.1, Vaadin Flow 25.3.0, PostgreSQL, and Flyway. Flow is the only UI model in scope; Hilla, React, and TypeScript are not included.

VAdmin owns the baseline experience through its default administration module. Consumers add business capabilities as AdminModule beans and Flow view beans; they do not create a shell, theme, or system-administration module for normal adoption. See the Modules guide for the module, translation, and production-anchor contract.

Quick Start

cp .env.example .env
docker compose --env-file .env up --build

Open http://localhost:8080 and sign in with admin and the value of APP_BOOTSTRAP_PASSWORD in .env.

Documentation

User guides

Guide Link
Getting Started Read
Modules Read
Configuration Read
Appearance Read
Security Read
Deployment Read

Developer guides

Guide Link
Architecture Read
Theme Policy Read
Release Guide Read
Requirements Read
Contributing Read

Verification

./mvnw -B -ntp verify
./mvnw -B -ntp -Pproduction verify
docker compose --env-file .env.example config
docker build -t vadmin:local .

Vaadin is a trademark of Vaadin Ltd. This project is not affiliated with, sponsored by, or endorsed by Vaadin Ltd.

About

VAdmin is a Java-first administration baseline for Vaadin Flow. | VAdmin 是一个以 Java 为核心的 Vaadin Flow 管理基础框架。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages