feat: integrate platform backend and application interfaces
This commit is contained in:
+19
-85
@@ -1,97 +1,31 @@
|
||||
<p style="display:flex; justify-content: center">
|
||||
# 元境幻生管理台
|
||||
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://tdesign.tencent.com/starter/react/#/dashboard/base" target="_blank">
|
||||
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg">
|
||||
</a>
|
||||
</p>
|
||||
`admin/` 是 MiragenFlow(元境幻生)V1 的管理员前端,基于 React、Vite 和 TDesign UI 组件构建。它只承载 `/admin/` 管理页面,不保存供应商密钥,不直接调用模型供应商接口。
|
||||
|
||||
<p align="center">
|
||||
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatibility"></a>
|
||||
<a href="https://github.com/Tencent/tdesign-react/blob/develop/LICENSE">
|
||||
<img src="https://img.shields.io/npm/l/tdesign-react.svg?sanitize=true" alt="License">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
English | [简体中文](./README-zh_CN.md)
|
||||
### Introduction
|
||||
|
||||
TDesign React Starter is a TDesign-based project developed with `React`, `Vite`. It can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects.
|
||||
|
||||
<p>
|
||||
<a href="http://tdesign.tencent.com/starter/react/">Live Preview</a>
|
||||
·
|
||||
<a href="https://tdesign.tencent.com/starter/docs/react/get-started">Documentation</a>
|
||||
</p>
|
||||
|
||||
<img src="docs/docs-starter.png">
|
||||
|
||||
### Features
|
||||
|
||||
- Various provided pages for develop
|
||||
- Complete directory structure for develop
|
||||
- Code specification configuration
|
||||
- Support dark mode
|
||||
- Custom theme colors
|
||||
- Various space layouts
|
||||
- Mock data scheme
|
||||
|
||||
### Usage
|
||||
|
||||
> Initialize project with our CLI tool `tdesign-starter-cli`
|
||||
## 本地开发
|
||||
|
||||
```bash
|
||||
## install tdesign-starter-cli
|
||||
npm i tdesign-starter-cli@latest -g
|
||||
|
||||
## create project
|
||||
td-starter init
|
||||
```
|
||||
|
||||
### Develop
|
||||
|
||||
```bash
|
||||
## install dependencies
|
||||
npm install
|
||||
|
||||
## set up
|
||||
npm run dev
|
||||
npm run dev:linux -- --port 3003
|
||||
```
|
||||
|
||||
### Build
|
||||
通常使用仓库根目录的 `node scripts/dev-all.mjs` 同时启动前台、管理台和 API 网关。生产环境由同一公网 origin 提供 `/`、`/admin/`、`/api/` 和 WebSocket。
|
||||
|
||||
## 管理范围
|
||||
|
||||
- 管理员独立登录、MFA、RBAC 和会话退出
|
||||
- 用户、认证消息和风控策略
|
||||
- 模型产品、分辨率、价格、渠道、渠道组和健康状态
|
||||
- 任务、attempt、队列、余额账本、充值订单、套餐和审批
|
||||
- WebDAV/临时存储策略、消息 outbox、审计日志
|
||||
|
||||
所有写请求必须经过服务端 `/api/v1/admin/*` 鉴权、幂等校验、版本校验和审计。页面展示的渠道凭证始终是脱敏状态;support 角色不能读取原始提示词、文件或密钥。
|
||||
|
||||
## 构建与检查
|
||||
|
||||
```bash
|
||||
## build
|
||||
npm run build
|
||||
|
||||
## build for test
|
||||
npm run build:test
|
||||
npm run lint
|
||||
```
|
||||
|
||||
|
||||
### Contributing Guide
|
||||
|
||||
We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-react-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-react-starter/pulls).
|
||||
|
||||
#### Pull Request
|
||||
|
||||
1. Fork it!
|
||||
2. Create your branch: `git checkout -b feat/xxxx`
|
||||
3. Commit: `git commit -a 'feat(project): describe'`
|
||||
4. Push: `git push origin feat/xxxx`
|
||||
5. New Pull Request `pull request`
|
||||
|
||||
#### Commit Specification
|
||||
|
||||
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
||||
|
||||
### Compatibility
|
||||
|
||||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
||||
|
||||
### License
|
||||
|
||||
The MIT License. Please see [the license file](LICENSE) for more information.
|
||||
管理台通过 `packages/contracts` 与前台共享公开 DTO、错误码和 WebSocket 事件类型。模板输入目录 `docs/design-reference/MiragenFlow-front/` 不属于管理台运行时依赖。
|
||||
|
||||
Reference in New Issue
Block a user