Skip to content

Commit fc12403

Browse files
committed
docs: add demo screenshots and render deploy workflow
1 parent d771d19 commit fc12403

13 files changed

Lines changed: 634 additions & 3 deletions
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Deploy Render
2+
3+
on:
4+
workflow_run:
5+
workflows:
6+
- Build Docker Image
7+
types:
8+
- completed
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
14+
concurrency:
15+
group: render-deploy
16+
cancel-in-progress: true
17+
18+
jobs:
19+
deploy:
20+
name: Trigger Render deploy hook
21+
runs-on: ubuntu-latest
22+
if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
23+
env:
24+
RENDER_DEPLOY_HOOK_URL: ${{ secrets.RENDER_DEPLOY_HOOK_URL }}
25+
steps:
26+
- name: Skip Render deploy
27+
if: ${{ env.RENDER_DEPLOY_HOOK_URL == '' }}
28+
run: echo "RENDER_DEPLOY_HOOK_URL is not configured; skipping Render deploy."
29+
30+
- name: Trigger Render deploy hook
31+
if: ${{ env.RENDER_DEPLOY_HOOK_URL != '' }}
32+
shell: bash
33+
run: |
34+
set -euo pipefail
35+
curl --fail --silent --show-error --request POST "$RENDER_DEPLOY_HOOK_URL"

README.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Codex2API
22

3+
[中文](README.md) | [English](README_EN.md)
4+
35
Codex2API 是一个基于 **Go + Gin + React/Vite** 的 Codex 反向代理与管理后台项目,支持:
46

57
- 标准模式:**PostgreSQL + Redis**
@@ -9,10 +11,52 @@ Codex2API 是一个基于 **Go + Gin + React/Vite** 的 Codex 反向代理与管
911

1012
---
1113

14+
## 在线 Demo
15+
16+
- Demo 地址:[https://codex2api-latest-vu8j.onrender.com](https://codex2api-latest-vu8j.onrender.com)
17+
- 管理后台:[https://codex2api-latest-vu8j.onrender.com/admin/](https://codex2api-latest-vu8j.onrender.com/admin/)
18+
- Demo 密码:`codex2api`
19+
20+
> Demo 环境仅用于体验管理后台界面和基础功能,请勿上传真实 Refresh Token、Access Token、API Key 或其他敏感信息。
21+
22+
---
23+
24+
## 界面预览
25+
26+
> 以下截图使用演示数据,实际页面会随账号池、请求日志和运行环境变化。
27+
28+
![CodexProxy 仪表盘](docs/screenshots/dashboard.png)
29+
30+
<details>
31+
<summary>查看更多后台界面</summary>
32+
33+
| 账号管理 | 仪表盘趋势 |
34+
| --- | --- |
35+
| ![账号管理](docs/screenshots/accounts.png) | ![仪表盘趋势](docs/screenshots/dashboard-trends.png) |
36+
37+
| 生图工作台 | Prompt 检查 |
38+
| --- | --- |
39+
| ![生图工作台](docs/screenshots/image-studio.png) | ![Prompt 检查](docs/screenshots/prompt-filter.png) |
40+
41+
| 系统运维 | 使用统计 |
42+
| --- | --- |
43+
| ![系统运维](docs/screenshots/operations.png) | ![使用统计](docs/screenshots/usage.png) |
44+
45+
| 使用文档 | API 文档 |
46+
| --- | --- |
47+
| ![使用文档](docs/screenshots/guide.png) | ![API 文档](docs/screenshots/api-reference.png) |
48+
49+
</details>
50+
51+
---
52+
1253
## 目录
1354

55+
- [在线 Demo](#在线-demo)
56+
- [界面预览](#界面预览)
1457
- [快速部署](#快速部署)
1558
- [完整文档](#完整文档)
59+
- [升级与本地开发](#升级与本地开发)
1660
- [环境配置](#环境配置)
1761
- [对外接口](#对外接口)
1862
- [Token 上传与账号管理](#token-上传与账号管理)
@@ -22,6 +66,7 @@ Codex2API 是一个基于 **Go + Gin + React/Vite** 的 Codex 反向代理与管
2266
- [常见注意事项](#常见注意事项)
2367
- [免责声明](#免责声明与开源协议)
2468
- [Star History](#star-history)
69+
- [友情链接](#友情链接)
2570

2671
---
2772

@@ -112,10 +157,11 @@ docker compose -f docker-compose.sqlite.local.yml logs -f codex2api
112157
| [架构文档](docs/ARCHITECTURE.md) | 系统架构、调度算法、存储设计 | `docs/ARCHITECTURE.md` |
113158
| [故障排查](docs/TROUBLESHOOTING.md) | 常见问题排查、诊断脚本、解决方案 | `docs/TROUBLESHOOTING.md` |
114159
| [贡献指南](docs/CONTRIBUTING.md) | 开发规范、PR 流程、代码标准 | `docs/CONTRIBUTING.md` |
160+
| [English README](README_EN.md) | 英文项目介绍、部署和后台功能概览 | `README_EN.md` |
115161

116162
---
117163

118-
## 环境配置
164+
## 升级与本地开发
119165

120166
```bash
121167
git pull && docker compose pull && docker compose up -d && docker compose logs -f codex2api
@@ -289,10 +335,16 @@ curl -X POST http://localhost:8080/api/admin/accounts/import \
289335
| --- | --- | --- |
290336
| Dashboard | `/admin/` | 总览指标、请求趋势、延迟趋势、Token 分布、模型排行 |
291337
| 账号管理 | `/admin/accounts` | 导入、测试、批量处理、调度信息查看 |
338+
| API 密钥 | `/admin/api-keys` | API Key 创建、查看、删除与调用凭据管理 |
339+
| 代理管理 | `/admin/proxies` | 代理池维护、账号代理分配与连通性管理 |
340+
| 生图工作台 | `/admin/images/studio` | 文生图、提示词模板、任务历史和服务器图库 |
341+
| Prompt 检查 | `/admin/prompt-filter/overview` | Prompt 规则、触发日志、测试和处理模式配置 |
292342
| 使用统计 | `/admin/usage` | 请求日志、统计卡片、图表、日志清空 |
293343
| 运维概览 | `/admin/ops` | 运行态监控与系统概览 |
294344
| 调度看板 | `/admin/ops/scheduler` | 调度健康度、惩罚项和评分拆解 |
295345
| 系统设置 | `/admin/settings` | 业务运行参数与后台密钥配置 |
346+
| 使用文档 | `/admin/docs` | Codex CLI / Claude Code 接入示例 |
347+
| API 文档 | `/admin/api-reference` | OpenAI 风格接口与管理接口参考 |
296348

297349
---
298350

@@ -383,10 +435,10 @@ codex2api/
383435
├─ auth/ # 账号池、调度与 token 管理
384436
├─ cache/ # Redis 缓存封装
385437
├─ config/ # 环境变量加载
386-
├─ database/ # PostgreSQL 访问层
438+
├─ database/ # 数据库访问层
387439
├─ proxy/ # 对外代理、转发与限流
388440
└─ frontend/ # React + Vite 管理后台
389-
├─ src/pages/ # Dashboard / Accounts / Usage / Ops / Settings
441+
├─ src/pages/ # Dashboard / Accounts / API Keys / Proxies / Images / Prompt Filter / Ops / Usage / Settings / Docs
390442
├─ src/components/ # UI 组件
391443
├─ src/locales/ # 国际化语言文件 (zh/en)
392444
└─ vite.config.js # Vite 配置

0 commit comments

Comments
 (0)