# ruike

**Repository Path**: ttlp/ruike

## Basic Information

- **Project Name**: ruike
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-29
- **Last Updated**: 2026-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Ruike 项目文档

文档覆盖 `ruike-boot` 多服务后端和 `ruike-web` 管理前端。更新基线：2026-11-06。

## 快速入口

- 前端开发、组件拆分、中英文切换、页面权限：[前端架构与开发指南](<./5.1 前端架构与开发指南.md>)。
- 接口参数与权限：[API 接口文档](<./API 接口文档.md>)；前端逐接口调用位置：[接口覆盖表](../ruike-web/API-COVERAGE.md)。
- 本地启动：[ruike-web README](../ruike-web/README.md)；上线准备：[部署架构](<./4.1 部署架构设计文档.md>)、[配置管理](<./4.2 配置管理设计文档.md>)、[测试策略](<./4.3 测试策略文档.md>)。
- Nacos 本地控制台与配置发布：[Nacos 配置说明](../ruike-boot/deploy/nacos/README.md)。
- Prometheus、Grafana、Alertmanager 与 Zipkin：[可观测性平台说明](../ruike-boot/monitoring/README.md)。
- 后端运行拓扑：`ruike-gateway:8080` → `ruike-auth:8083` / `ruike-system:8081` / `ruike-monitor:8082`。

## 文档目录

| 主题 | 文档 |
| --- | --- |
| 总体设计 | [系统架构](<./1.1 系统架构设计文档.md>)、[数据库](<./1.2 数据库设计文档.md>) |
| 权限体系 | [认证授权](<./2.1 认证授权模块设计文档.md>)、[数据权限](<./2.2 数据权限模块设计文档.md>) |
| 多语言与枚举 | [枚举体系](<./2.3 枚举体系设计文档.md>)、[国际化](<./2.4 国际化设计文档.md>) |
| 基础服务 | [缓存](<./3.1 缓存设计文档.md>)、[异常与错误码](<./3.2 异常与错误码设计文档.md>)、[日志与审计](<./3.3 日志与审计设计文档.md>)、[文件存储](<./3.4 文件存储设计文档.md>) |
| 工程交付 | [部署架构](<./4.1 部署架构设计文档.md>)、[配置管理](<./4.2 配置管理设计文档.md>)、[测试策略](<./4.3 测试策略文档.md>) |
| 前端工程 | [前端架构与开发指南](<./5.1 前端架构与开发指南.md>) |
| 接口契约 | [API 接口文档](<./API 接口文档.md>) |

## 阅读约定

- 设计目标不等同于已交付能力；前端当前实现和待联调事项以指南及覆盖表为准。
- 后端当前 14 个业务 Controller、95 个方法级操作；前端覆盖 94 个，兼容接口 `/system/users/force-logout` 未接入。
- 覆盖不代表所有接口均已完成真实业务联调。
- 文档以当前代码和运行接口为基线；设计目标与已交付能力分开描述。