# danburen/waterfun architecture

> Architecture diagram of the GitHub repository danburen/waterfun, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/danburen/waterfun
- Repository: https://github.com/danburen/waterfun

## Overview

WaterFun is a community forum with user-facing and administrative applications backed by a gateway-centric Java service architecture. The main user flow runs from the web client through the gateway to user APIs for authentication, content, uploads, tickets, and notifications. Tickets are submitted asynchronously and reviewed by administrators; the README describes penalty application and real-time notification after review. The graph includes documented capabilities such as moderation, bans, RBAC, dashboards, and monitoring. Most implementation links are not shown in the excerpts, so unverified relationships are dashed.

Main entry points: [`waterfun-service/src/main/java/org/waterfun/service/web`](https://github.com/danburen/waterfun/tree/main/waterfun-service/src/main/java/org/waterfun/service/web) (User API), [`waterfun-admin-service/src/main/java/org/waterfun/service/admin`](https://github.com/danburen/waterfun/tree/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin) (Admin API), [`waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/ModerationServiceImpl.java`](https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/ModerationServiceImpl.java) (Content moderation), [`waterfun-gateway/src/main/java/org/waterfun/service/gateway`](https://github.com/danburen/waterfun/tree/main/waterfun-gateway/src/main/java/org/waterfun/service/gateway) (API gateway)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_clients["Client applications"]
  node_web["Forum client"]
  node_adminui["Admin dashboard"]
end

subgraph group_edge["Gateway and APIs"]
  node_gateway{{"API gateway"}}
  node_userapi["User API"]
  node_adminapi["Admin API"]
end

subgraph group_community["Community features"]
  node_auth["Authentication"]
  node_content["Posts and profiles"]
  node_uploads["Object uploads"]
  node_tickets["Tickets and appeals"]
  node_notifications["Inbox and realtime"]
end

subgraph group_admin["Administration"]
  node_moderation["Content moderation"]
  node_ban["Ban management"]
  node_dashboard["Dashboard and stats"]
  node_rbac["Users and access"]
  node_monitor["System monitoring"]
end

subgraph group_platform["Shared platform"]
  node_core["Shared business core"]
  node_mysql[("MySQL")]
  node_redis[("Redis")]
  node_rabbit["RabbitMQ"]
  node_cos["Tencent COS"]
end

node_member(("Forum user"))
node_adminuser(("Administrator"))
node_sse(("SSE clients"))

node_member -.->|"uses"| node_web
node_adminuser -.->|"uses"| node_adminui
node_web -.->|"API requests"| node_gateway
node_adminui -.->|"API requests"| node_gateway
node_gateway -->|"routes to"| node_userapi
node_gateway -->|"routes to"| node_adminapi
node_userapi -.->|"delegates"| node_auth
node_userapi -.->|"delegates"| node_content
node_userapi -.->|"requests upload"| node_uploads
node_userapi -.->|"submits"| node_tickets
node_userapi -.->|"serves inbox"| node_notifications
node_adminapi -.->|"reviews content"| node_moderation
node_adminapi -.->|"manages penalties"| node_ban
node_adminapi -.->|"serves dashboard"| node_dashboard
node_adminapi -.->|"manages access"| node_rbac
node_adminapi -.->|"serves monitoring"| node_monitor
node_tickets -->|"queues review"| node_rabbit
node_adminuser -.->|"reviews tickets"| node_moderation
node_moderation -->|"applies penalty"| node_ban
node_moderation -->|"triggers notification"| node_notifications
node_notifications -->|"pushes updates"| node_sse
node_auth -->|"rotates token state"| node_redis
node_core -->|"persists source data"| node_mysql
node_core -->|"uses transient state"| node_redis
node_uploads -->|"stores files"| node_cos
node_moderation -->|"uses async callbacks"| node_rabbit

click node_web "https://github.com/danburen/waterfun/tree/main/waterfun-web-client/src"
click node_adminui "https://github.com/danburen/waterfun/tree/main/waterfun-admin/src"
click node_gateway "https://github.com/danburen/waterfun/tree/main/waterfun-gateway/src/main/java/org/waterfun/service/gateway"
click node_userapi "https://github.com/danburen/waterfun/tree/main/waterfun-service/src/main/java/org/waterfun/service/web"
click node_adminapi "https://github.com/danburen/waterfun/tree/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin"
click node_auth "https://github.com/danburen/waterfun/tree/main/waterfun-service-core/src/main/java/org/waterfun/service/core/services/auth"
click node_content "https://github.com/danburen/waterfun/tree/main/waterfun-service/src/main/java/org/waterfun/service/web/service"
click node_uploads "https://github.com/danburen/waterfun/tree/main/waterfun-service-core/src/main/java/org/waterfun/service/core/services/sys/storage"
click node_tickets "https://github.com/danburen/waterfun/tree/main/waterfun-service/src/main/java/org/waterfun/service/web/service/report"
click node_notifications "https://github.com/danburen/waterfun/blob/main/waterfun-service/src/main/java/org/waterfun/service/web/service/NotificationService.java"
click node_moderation "https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/ModerationServiceImpl.java"
click node_ban "https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/IpBanServiceImpl.java"
click node_dashboard "https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/DashboardService.java"
click node_rbac "https://github.com/danburen/waterfun/tree/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service"
click node_monitor "https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/MonitorService.java"
click node_core "https://github.com/danburen/waterfun/tree/main/waterfun-service-core/src/main/java/org/waterfun/service/core"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_web,node_adminui,node_member,node_sse toneBlue
class node_gateway,node_userapi,node_adminapi toneAmber
class node_auth,node_content,node_uploads,node_tickets,node_notifications toneMint
class node_moderation,node_ban,node_dashboard,node_rbac,node_monitor toneRose
class node_core,node_mysql,node_redis,node_rabbit,node_cos,node_adminuser toneIndigo
```

## Components

### Client applications

- [Forum client](https://github.com/danburen/waterfun/tree/main/waterfun-web-client/src): `waterfun-web-client/src`
- [Admin dashboard](https://github.com/danburen/waterfun/tree/main/waterfun-admin/src): `waterfun-admin/src`

### Gateway and APIs

- [API gateway](https://github.com/danburen/waterfun/tree/main/waterfun-gateway/src/main/java/org/waterfun/service/gateway): `waterfun-gateway/src/main/java/org/waterfun/service/gateway`
- [User API](https://github.com/danburen/waterfun/tree/main/waterfun-service/src/main/java/org/waterfun/service/web): `waterfun-service/src/main/java/org/waterfun/service/web`
- [Admin API](https://github.com/danburen/waterfun/tree/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin): `waterfun-admin-service/src/main/java/org/waterfun/service/admin`

### Community features

- [Authentication](https://github.com/danburen/waterfun/tree/main/waterfun-service-core/src/main/java/org/waterfun/service/core/services/auth): `waterfun-service-core/src/main/java/org/waterfun/service/core/services/auth`
- [Posts and profiles](https://github.com/danburen/waterfun/tree/main/waterfun-service/src/main/java/org/waterfun/service/web/service): `waterfun-service/src/main/java/org/waterfun/service/web/service`
- [Object uploads](https://github.com/danburen/waterfun/tree/main/waterfun-service-core/src/main/java/org/waterfun/service/core/services/sys/storage): `waterfun-service-core/src/main/java/org/waterfun/service/core/services/sys/storage`
- [Tickets and appeals](https://github.com/danburen/waterfun/tree/main/waterfun-service/src/main/java/org/waterfun/service/web/service/report): `waterfun-service/src/main/java/org/waterfun/service/web/service/report`
- [Inbox and realtime](https://github.com/danburen/waterfun/blob/main/waterfun-service/src/main/java/org/waterfun/service/web/service/NotificationService.java): `waterfun-service/src/main/java/org/waterfun/service/web/service/NotificationService.java`

### Administration

- [Content moderation](https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/ModerationServiceImpl.java): `waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/ModerationServiceImpl.java`
- [Ban management](https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/IpBanServiceImpl.java): `waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/IpBanServiceImpl.java`
- [Dashboard and stats](https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/DashboardService.java): `waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/DashboardService.java`
- [Users and access](https://github.com/danburen/waterfun/tree/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service): `waterfun-admin-service/src/main/java/org/waterfun/service/admin/service`
- [System monitoring](https://github.com/danburen/waterfun/blob/main/waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/MonitorService.java): `waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/MonitorService.java`

### Shared platform

- [Shared business core](https://github.com/danburen/waterfun/tree/main/waterfun-service-core/src/main/java/org/waterfun/service/core): `waterfun-service-core/src/main/java/org/waterfun/service/core`
- **MySQL**
- **Redis**
- **RabbitMQ**
- **Tencent COS**

### Other components

- **Forum user**
- **Administrator**
- **SSE clients**

## Connections

- Forum user → Forum client: uses
- Administrator → Admin dashboard: uses
- Forum client → API gateway: API requests
- Admin dashboard → API gateway: API requests
- API gateway → User API: routes to (evidence: `README.md`)
- API gateway → Admin API: routes to (evidence: `README.md`)
- User API → Authentication: delegates
- User API → Posts and profiles: delegates (evidence: `waterfun-service/src/main/java/org/waterfun/service/web/service/resource/ResourceService.java`)
- User API → Object uploads: requests upload
- User API → Tickets and appeals: submits (evidence: `waterfun-service/src/main/java/org/waterfun/service/web/service/report/ReportService.java`)
- User API → Inbox and realtime: serves inbox (evidence: `waterfun-service/src/main/java/org/waterfun/service/web/service/NotificationService.java`)
- Admin API → Content moderation: reviews content
- Admin API → Ban management: manages penalties
- Admin API → Dashboard and stats: serves dashboard (evidence: `waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/DashboardService.java`)
- Admin API → Users and access: manages access (evidence: `waterfun-admin-service/src/main/java/org/waterfun/service/admin/service/auth/AuthService.java`)
- Admin API → System monitoring: serves monitoring
- Tickets and appeals → RabbitMQ: queues review (evidence: `README.md`)
- Administrator → Content moderation: reviews tickets
- Content moderation → Ban management: applies penalty (evidence: `README.md`)
- Content moderation → Inbox and realtime: triggers notification (evidence: `README.md`)
- Inbox and realtime → SSE clients: pushes updates (evidence: `README.md`)
- Authentication → Redis: rotates token state (evidence: `README.md`)
- Shared business core → MySQL: persists source data (evidence: `README.md`)
- Shared business core → Redis: uses transient state (evidence: `README.md`)
- Object uploads → Tencent COS: stores files (evidence: `README.md`)
- Content moderation → RabbitMQ: uses async callbacks (evidence: `README.md`)
