docs: update README with new project mission and bilingual support
This commit is contained in:
parent
740a595d84
commit
8112d8bff2
89
README.md
Normal file
89
README.md
Normal file
@ -0,0 +1,89 @@
|
||||
# console.svc.plus
|
||||
|
||||
**工程师 · 开源 · 云中立**
|
||||
|
||||
关注 **Ops / Infra / AI** 与 **技术自由**。
|
||||
🏗️ 热衷于构建“逃生舱”,防止基础设施被厂商锁定。
|
||||
|
||||
> **Accountable Engineer · Open Source · Cloud Neutral**
|
||||
>
|
||||
> Focus on **Ops / Infra / AI** and **Technical Freedom**.
|
||||
> 🏗️ Passionate about building "escape pods" to prevent infrastructure vendor lock-in.
|
||||
|
||||
---
|
||||
|
||||
**console.svc.plus** 是 Cloud Neutral Toolkit 的**开放云控制面板**。
|
||||
|
||||
> **console.svc.plus** is the **Open Cloud Control Panel** for the Cloud Neutral Toolkit.
|
||||
|
||||
## 项目简介 (About The Project)
|
||||
|
||||
本项目是 Cloud Neutral 生态系统的核心可视化界面(前端仪表盘)。它连接各个微服务,为管理云中立基础设施提供统一的控制平面。
|
||||
|
||||
> This repository serves as the central visual interface (Frontend Dashboard) for the Cloud Neutral ecosystem. It connects various micro-services to provide a unified control plane for managing your cloud-neutral infrastructure.
|
||||
|
||||
该生态系统目前包含多个专用的微后端和服务:
|
||||
|
||||
* **console.svc.plus**: (本项目) 主前端仪表盘。
|
||||
* **accounts.svc.plus**: 身份与账户管理服务。
|
||||
* **postgresql.svc.plus**: 带有专用扩展的 PostgreSQL 数据库服务。
|
||||
* **rag-server.svc.plus**: 检索增强生成 (RAG) 后端。
|
||||
* **page-reading-agent-backend**: 页面阅读智能体后端逻辑。
|
||||
* **page-reading-agent-dashboard**: 页面阅读智能体专用仪表盘。
|
||||
* **wechat-to-markdown.svc.plus**: 微信内容转 Markdown 工具服务。
|
||||
|
||||
## 技术栈 (Tech Stack)
|
||||
|
||||
本仪表盘使用现代 Web 技术构建:
|
||||
> This dashboard is built using modern web technologies:
|
||||
|
||||
* **框架**: [Next.js](https://nextjs.org/)
|
||||
* **语言**: TypeScript
|
||||
* **样式**: [Tailwind CSS](https://tailwindcss.com/)
|
||||
* **UI 组件**: [Radix UI](https://www.radix-ui.com/)
|
||||
* **内容管理**: [Contentlayer](https://contentlayer.dev/)
|
||||
|
||||
## 快速开始 (Getting Started)
|
||||
|
||||
### 前置要求 (Prerequisites)
|
||||
|
||||
* Node.js (`>=18.17 <25`)
|
||||
* Yarn (推荐) 或 npm
|
||||
|
||||
### 安装 (Installation)
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
### 本地运行 (Running Locally)
|
||||
|
||||
启动开发服务器:
|
||||
> To start the development server:
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
此命令会运行设置脚本 (`scripts/Dev-MCP-Server.sh`) 并启动带有 TurboPack 的 Next.js 开发服务器。
|
||||
> This command runs the setup script (`scripts/Dev-MCP-Server.sh`) and starts the Next.js development server with TurboPack.
|
||||
|
||||
### 构建生产版本 (Building for Production)
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
```
|
||||
|
||||
## 开发指南 (Development Guidelines)
|
||||
|
||||
有关详细的编码标准、架构规则和 Agent 特定说明,请参阅 [AGENTS.md](./AGENTS.md)。
|
||||
|
||||
> For detailed coding standards, architecture rules, and agent-specific instructions, please refer to [AGENTS.md](./AGENTS.md).
|
||||
|
||||
## 脚本 (Scripts)
|
||||
|
||||
* `dev`: 启动开发服务器。
|
||||
* `build`: 构建生产版本应用。
|
||||
* `test`: 使用 Vitest 运行单元测试。
|
||||
* `test:e2e`: 使用 Playwright 运行端到端测试。
|
||||
* `lint`: 运行代码检查 (Linter)。
|
||||
Loading…
Reference in New Issue
Block a user