重写根目录 README

2026-04-12 16:45:24 +08:00
parent b63fbc31bb
commit e2baf6c7bb
1 changed files with 67 additions and 77 deletions
--- a/README.md
+++ b/README.md
@@ -1,77 +1,67 @@
-# InfoGenie（万象口袋）
-
-多模块仓库：**React + Vite 前端**为主界面，**Go（Gin + GORM）** 为当前主力 API，另有 **Java Spring Boot** 占位模块。大量 **60s 类接口**通过上游开放 API 提供；本站负责聚合导航、认证跳转、AI 应用壳与小游戏嵌入等。
-
---
-
-## 仓库结构
-
-| 目录 | 说明 |
-|------|------|
-| [`infogenie-frontend/`](infogenie-frontend/) | 主站 SPA（Vite 6、React 18、Tailwind v4） |
-| [`infogenie-backend-go/`](infogenie-backend-go/) | **万象后端 API**（Go）：站点配置、AI 代理、健康检查、可选 Redis 缓存等 |
-| [`infogenie-backend-java/`](infogenie-backend-java/) | Spring Boot 3.5 骨架（当前无业务 API 层） |
-| [`InfoGenie-go-backend/`](InfoGenie-go-backend/) | 历史/备用目录，通常仅 README |
-
-详细 API、表结构、Redis 与诊断接口见 **[infogenie-backend-go/后端文档.md](infogenie-backend-go/后端文档.md)**。
-
-前端路由、Vite、管理员「状态监控」、静态页协作见 **[infogenie-frontend/前端文档.md](infogenie-frontend/前端文档.md)**。
-
-开发与 AI 助手指南见根目录 **[CLAUDE.md](CLAUDE.md)**（若存在）。
-
---
-
-## 快速启动（本地）
-
-### 前端（`infogenie-frontend/`）
-
-```bash
-cd infogenie-frontend
-npm install
-npm run dev
-```
-
-默认 **http://localhost:3000**。环境变量见 `infogenie-frontend/.env.development`（`VITE_API_URL` 默认指向本机 Go **5002**）。
-
-### Go 后端（`infogenie-backend-go/`）
-
-```bash
-cd infogenie-backend-go
-# 按需配置 .env.development（APP_ENV、DB_*、可选 REDIS_*）
-go run ./cmd/server
-```
-
-默认监听 **http://127.0.0.1:5002**。健康检查：**GET /api/health**。
-
-### Java 后端（可选）
-
-```bash
-cd infogenie-backend-java
-mvn spring-boot:run
-```
-
---
-
-## 环境变量要点
-
-| 模块 | 说明 |
-|------|------|
-| 前端 | `VITE_API_URL`、`VITE_AUTH_URL`、`VITE_AUTH_API_URL`、`VITE_DEBUG`（见前端文档） |
-| Go | `APP_ENV`、`APP_PORT`、`DB_*`、`INFOGENIE_SITE_ADMIN_TOKEN`、可选 `REDIS_*`、`AUTH_CENTER_API_URL` 等（见后端文档） |
-
-**不要**将含真实密码的 `.env` 提交到版本库。
-
---
-
-## 对外能力摘要（Go）
-
- **用户**：JWT 校验；登录由萌芽认证中心完成；`/api/user/profile` 等。
- **站点**：60s / AI 显隐、60s 上游、功能卡片点击统计；管理员 `X-Site-Admin-Token` 写入配置。
- **AI**：`/api/aimodelapp/chat`、`/chat/stream`（SSE）及多个垂直能力；模型白名单在后端维护。
- **可观测性**：`/api/health`；管理员 **`/api/admin/site/diagnostics`**（连接摘要，无密码明文）。
-
---
-
-## 许可证与备注
-
-具体许可证以前端 `package.json` 与各子项目声明为准。若文档与代码不一致，以当前代码与 **`后端文档.md` / `前端文档.md`** 为准。
+# InfoGenie / 万象口袋
+
+InfoGenie 是一个前后端分离的聚合型 Web 项目，包含 React + Vite 前端、Go 后端，以及一个独立的 Java 模块。前端负责门户、工具入口、小游戏和 AI 应用壳，Go 后端提供站点配置、AI 代理、健康检查和基础管理接口。
+
+## 项目结构
+
+- `InfoGenie-frontend/` - 主前端应用
+- `infogenie-backend-go/` - 当前主力后端 API
+- `infogenie-backend-java/` - Java Spring Boot 模块
+
+## 功能概览
+
+- 60s 类资讯聚合与榜单展示
+- 工具箱与静态小应用嵌入
+- AI 应用与流式对话接口
+- 管理端站点配置
+- 健康检查与运行状态诊断
+
+## 快速开始
+
+### 前端
+
+```bash
+cd InfoGenie-frontend
+npm install
+npm run dev
+```
+
+默认地址：`http://localhost:3000`
+
+### Go 后端
+
+```bash
+cd infogenie-backend-go
+go run ./cmd/server
+```
+
+默认地址：`http://127.0.0.1:5002`
+
+### Java 模块
+
+```bash
+cd infogenie-backend-java
+mvn spring-boot:run
+```
+
+## 生产部署
+
+- 前端生产构建使用 `npm run build`
+- Go 后端支持 Docker 部署，见 [`infogenie-backend-go/后端文档.md`](infogenie-backend-go/后端文档.md)
+- 运行时配置通过环境变量或 `.env` 文件注入
+
+## 配置说明
+
+- 不要提交真实密钥、数据库密码、JWT、Redis 等敏感信息
+- 示例配置文件见各模块目录下的 `.env.example` 或 `.env.production.example`
+- 前端 API 地址通过 `VITE_API_URL` 配置
+- Go 后端的数据库、Redis、认证中心配置通过环境变量控制
+
+## 文档
+
+- [`InfoGenie-frontend/前端文档.md`](InfoGenie-frontend/前端文档.md)
+- [`infogenie-backend-go/后端文档.md`](infogenie-backend-go/后端文档.md)
+
+## 说明
+
+仓库中部分静态资源和子模块内容较多，README 只保留对外可读的最小信息。需要更细的实现说明时，优先查看对应子目录文档。