Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

English | [简体中文](README.zh-CN.md)

VAdmin is a Java-first administration baseline for Vaadin Flow. Its reusable
VAdmin is a Java-first administration baseline for [Vaadin Flow](https://vaadin.com/docs/latest/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
Expand All @@ -18,7 +18,7 @@ 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 English
or system-administration module for normal adoption. See the
[Modules](docs/en/user/modules.md) guide for the module, translation, and
production-anchor contract.

Expand All @@ -44,7 +44,6 @@ Open `http://localhost:8080` and sign in with `admin` and the value of
| Appearance | [Read](docs/en/user/appearance.md) |
| Security | [Read](docs/en/user/security.md) |
| Deployment | [Read](docs/en/user/deployment.md) |
| Upgrade | [Read](docs/en/user/upgrade.md) |

**Developer guides**

Expand Down
3 changes: 1 addition & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

简体中文 | [English](README.md)

VAdmin 是一个 Java 优先、面向 Vaadin Flow 的管理基线。它的可复用核心——
VAdmin 是一个 Java 优先、面向 [Vaadin Flow](https://vaadin.com/docs/latest/flow) 的管理基线。它的可复用核心——
身份与权限契约、RBAC 用例和共享外壳模式——框架无关,运行时专属行为归入适配层,
因此 Spring Boot 之外的运行时(如 Quarkus、Helidon、Jakarta EE)仍是未来可能的
适配方向。Spring Boot 是当前唯一受支持的运行时:添加 `vadmin-spring-boot-starter`
Expand Down Expand Up @@ -38,7 +38,6 @@ docker compose --env-file .env up --build
| 外观配置 | [阅读](docs/zh-CN/user/appearance.md) |
| 安全说明 | [阅读](docs/zh-CN/user/security.md) |
| 部署 | [阅读](docs/zh-CN/user/deployment.md) |
| 升级 | [阅读](docs/zh-CN/user/upgrade.md) |

**开发者指南**

Expand Down
2 changes: 1 addition & 1 deletion docs/en/dev/release-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

VAdmin publication coordinate: `io.github.huahill:vadmin-spring-boot-starter`.

[简体中文](../../zh-CN/dev/release-guide.md) | English
English | [简体中文](../../zh-CN/dev/release-guide.md)

## Scope

Expand Down
2 changes: 1 addition & 1 deletion docs/en/dev/theme-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

VAdmin publication coordinate: `io.github.huahill:vadmin-spring-boot-starter`.

[简体中文](../../zh-CN/dev/theme-tokens.md) | English
English | [简体中文](../../zh-CN/dev/theme-tokens.md)

`vadmin` owns the default Vaadin Flow shell. Its
`DefaultApplicationShell` loads Aura with `@StyleSheet(Aura.STYLESHEET)`.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/user/appearance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Appearance

[简体中文](../../zh-CN/user/appearance.md) | English
English | [简体中文](../../zh-CN/user/appearance.md)

VAdmin uses Vaadin Aura as-is. Users pick system, light, or dark color schemes
from the shell's user menu through Vaadin's `ColorScheme` API.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/user/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration Reference

[简体中文](../../zh-CN/user/configuration.md) | English
English | [简体中文](../../zh-CN/user/configuration.md)

All settings are ordinary Spring Boot properties. Only the datasource is
required; everything else has a working default.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/user/deployment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deployment

[简体中文](../../zh-CN/user/deployment.md) | English
English | [简体中文](../../zh-CN/user/deployment.md)

VAdmin is a regular Spring Boot library — deploy your application the way you
already do. This guide covers the VAdmin-specific concerns to check before
Expand Down
3 changes: 1 addition & 2 deletions docs/en/user/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

[简体中文](../../zh-CN/user/getting-started.md) | English
English | [简体中文](../../zh-CN/user/getting-started.md)

Add one dependency to an existing Spring Boot application and start it. You
get sign-in with a bootstrap administrator, permission-filtered navigation,
Expand Down Expand Up @@ -126,7 +126,6 @@ Open `http://localhost:8080` and sign in with `admin` and the value of
- Add business pages with the [Modules](modules.md) guide.
- Review the [Security](security.md) model before production.
- Deploy with the [Deployment](deployment.md) guide.
- Move between versions with the [Upgrade](upgrade.md) guide.
- Change the look with the [Appearance](appearance.md) guide.

Only a deliberate full shell replacement needs a consumer `AdminHostLayout`
Expand Down
2 changes: 1 addition & 1 deletion docs/en/user/modules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Modules

[简体中文](../../zh-CN/user/modules.md) | English
English | [简体中文](../../zh-CN/user/modules.md)

VAdmin ships a complete administration shell out of the box. You add
business pages by declaring a module — a small Spring configuration that
Expand Down
2 changes: 1 addition & 1 deletion docs/en/user/security.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Security

[简体中文](../../zh-CN/user/security.md) | English
English | [简体中文](../../zh-CN/user/security.md)

## Sign-In

Expand Down
33 changes: 0 additions & 33 deletions docs/en/user/upgrade.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/zh-CN/dev/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

VAdmin 的发布坐标为 `io.github.huahill:vadmin-spring-boot-starter`。

[English](../../en/dev/architecture.md) | 简体中文
简体中文 | [English](../../en/dev/architecture.md)

## 范围

Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/dev/release-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

VAdmin 的发布坐标为 `io.github.huahill:vadmin-spring-boot-starter`。

[English](../../en/dev/release-guide.md) | 简体中文
简体中文 | [English](../../en/dev/release-guide.md)

## 范围

Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/dev/theme-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

VAdmin 的发布坐标为 `io.github.huahill:vadmin-spring-boot-starter`。

[English](../../en/dev/theme-tokens.md) | 简体中文
简体中文 | [English](../../en/dev/theme-tokens.md)

`vadmin` 拥有默认的 Vaadin Flow 外壳。其 `DefaultApplicationShell` 通过
`@StyleSheet(Aura.STYLESHEET)` 加载 Aura。普通使用方和业务模块不得定义竞争性的
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/user/appearance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 外观配置

[English](../../en/user/appearance.md) | 简体中文
简体中文 | [English](../../en/user/appearance.md)

VAdmin 直接使用 Vaadin Aura。用户可通过外壳用户菜单,用 Vaadin 的
`ColorScheme` API 在跟随系统、浅色和深色之间切换。
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/user/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 配置参考

[English](../../en/user/configuration.md) | 简体中文
简体中文 | [English](../../en/user/configuration.md)

所有配置都是普通的 Spring Boot 属性。只有数据源是必需项,其余配置都有可用默认值。

Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/user/deployment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 部署

[English](../../en/user/deployment.md) | 简体中文
简体中文 | [English](../../en/user/deployment.md)

VAdmin 是一个普通的 Spring Boot 库——按你已有的方式部署应用即可。本指南涵盖上线前
需要检查的 VAdmin 相关事项。
Expand Down
3 changes: 1 addition & 2 deletions docs/zh-CN/user/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 快速开始

[English](../../en/user/getting-started.md) | 简体中文
简体中文 | [English](../../en/user/getting-started.md)

向已有的 Spring Boot 应用添加一个依赖并启动,即可获得:引导管理员登录、
按权限过滤的导航、默认外壳与主题、Users/Roles/Permissions/Audit 系统管理模块、
Expand Down Expand Up @@ -113,7 +113,6 @@ docker compose --env-file .env up --build
- 用[模块开发](modules.md)指南添加业务页面。
- 上线前阅读[安全说明](security.md)。
- 用[部署与运维](deployment.md)指南完成部署。
- 用[升级指南](upgrade.md)在版本间迁移。
- 用[外观配置](appearance.md)调整外观。

只有有意完全替换外壳时,使用方才需要提供 `AdminHostLayout` 和
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/user/modules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 模块开发

[English](../../en/user/modules.md) | 简体中文
简体中文 | [English](../../en/user/modules.md)

VAdmin 自带完整的管理外壳。你通过声明模块来添加业务页面——一个小型 Spring 配置,
告诉 VAdmin 路由、权限、翻译和视图 Bean。无需任何外壳、布局或主题工作。
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/user/security.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 安全说明

[English](../../en/user/security.md) | 简体中文
简体中文 | [English](../../en/user/security.md)

## 登录

Expand Down
26 changes: 0 additions & 26 deletions docs/zh-CN/user/upgrade.md

This file was deleted.

72 changes: 72 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,68 @@
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>vaadin-bom</artifactId>
<version>${vaadin.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.flywaydb</groupId>
<artifactId>flyway-core</artifactId>
<version>${flyway.version}</version>
</dependency>
<dependency>
<groupId>org.flywaydb</groupId>
<artifactId>flyway-database-postgresql</artifactId>
<version>${flyway.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-contracts</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-platform</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-flow</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-spring-security</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-spring-jpa</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-spring-boot</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-spring-flow</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-spring-boot-starter</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
</dependencyManagement>

Expand Down Expand Up @@ -181,6 +243,16 @@
<artifactId>spring-boot-maven-plugin</artifactId>
<version>${spring-boot.version}</version>
</plugin>
<plugin>
<groupId>com.vaadin</groupId>
<artifactId>flow-maven-plugin</artifactId>
<version>${vaadin.version}</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.6.4</version>
</plugin>
</plugins>
</pluginManagement>
</build>
Expand Down
2 changes: 0 additions & 2 deletions vadmin-flow/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-platform</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>vaadin-core</artifactId>
<version>${vaadin.version}</version>
</dependency>
<dependency>
<groupId>jakarta.servlet</groupId>
Expand Down
1 change: 0 additions & 1 deletion vadmin-platform/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
<dependency>
<groupId>io.github.huahill</groupId>
<artifactId>vadmin-contracts</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
Expand Down
Loading
Loading