From 8b15e804ea12f4375220ddd36ed1ffb90249acf8 Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Tue, 24 Jun 2025 02:46:57 +0000
Subject: [PATCH] Update README.md

---
 templates/app/src/docs/README.md | 106 ++++++++++++++++++++++++++++++-
 1 file changed, 104 insertions(+), 2 deletions(-)

diff --git a/templates/app/src/docs/README.md b/templates/app/src/docs/README.md
index da2056b..7182e73 100644
--- a/templates/app/src/docs/README.md
+++ b/templates/app/src/docs/README.md
@@ -1,3 +1,105 @@
-# Headline
+# NebulaJS 云平台
 
-> An awesome project.
+## 平台简介
+NebulaJS 是一个低代码开发平台，提供应用开发、运行维护、通用云功能和流程管理等模块。通过 NebulaJS，开发者可以快速构建企业级应用程序，并实现业务流程的可视化设计与管理。
+
+## 平台功能
+
+### 应用开发
+- **模型管理**：支持创建和管理数据模型，定义模型属性和关系。
+- **接口生成**：根据模型自动生成 RESTful 接口。
+- **页面生成**：通过可视化页面设计器生成前端页面。
+- **菜单配置**：生成并配置应用菜单，实现权限控制。
+
+### 运行维护
+- **实例管理**：查看和管理应用实例的详细信息。
+- **日志管理**：实时查看应用运行日志，支持日志级别配置。
+- **任务调度**：支持定时任务的创建和运行。
+
+### 通用云功能
+- **组织管理**：管理企业组织架构，分配用户权限。
+- **角色管理**：定义角色并分配菜单权限。
+- **用户管理**：管理用户账户，支持密码重置和角色分配。
+- **字典管理**：维护系统通用字典数据。
+
+### 流程功能
+- **流程设计**：通过流程设计器定义业务流程。
+- **流程管理**：支持流程分组、新增和处理。
+- **任务处理**：支持流程任务的创建、运行和监控。
+
+## 演示图
+
+### 云平台
+展示 NebulaJS 云平台的整体界面布局，包括导航栏、侧边栏和主工作区。
+
+### 页面设计器
+展示页面设计器的界面，支持拖拽组件、属性配置和预览功能。
+
+### 流程设计器
+展示流程设计器的界面，支持流程节点的拖拽、连接和配置。
+
+### 代码编辑器
+展示代码编辑器的界面，支持代码编写、调试和版本控制。
+
+### 云应用
+展示云应用的运行界面，包括仪表盘、数据展示和操作面板。
+
+## 在线文档
+- [快速开始](docs/zh-cn/quickstart.md)
+- [技术栈](docs/zh-cn/develop.md#1-技术栈)
+- [业务开发](docs/zh-cn/develop.md#3-业务开发)
+- [系统功能](docs/zh-cn/functions.md)
+
+## 技术交流
+欢迎加入我们的技术交流群，获取更多帮助和支持。
+
+## 开发文档
+
+### 环境配置
+1. **Node.js 安装**：确保已安装 Node.js 16 或更高版本。
+2. **Docker/Docker Compose 安装**：安装 Docker 和 Docker Compose 以支持容器化部署。
+3. **环境变量配置**：根据需求配置环境变量，如数据库连接、日志级别等。
+
+### 中间件配置
+支持多种数据库，包括：
+- **PostgreSQL**
+- **MySQL（推荐）**
+- **MariaDB**
+- **SQLite**
+- **Microsoft SQL Server**
+- **Oracle Database**
+
+使用 Docker 快速启动开发环境：
+```bash
+docker-compose up -d
+```
+
+### 云服务端配置
+根据实际需求配置云服务端参数，如认证方式、主数据库、数据缓存等。
+
+### 启动应用
+1. **Docker Socat 启动**：
+   ```bash
+   docker run -d --name nebula-app -p 3000:3000 nebula-app
+   ```
+2. **TypeScript 编译监听**：
+   ```bash
+   npm run watch
+   ```
+3. **应用启动**：
+   ```bash
+   npm start
+   ```
+
+## 常见问题
+请参考 [常见问题文档](docs/zh-cn/qa.md) 获取常见问题的解答。
+
+## 贡献指南
+欢迎贡献代码和文档。请遵循以下步骤：
+1. Fork 仓库。
+2. 创建新分支。
+3. 提交代码。
+4. 创建 Pull Request。
+
+## 许可证
+本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。
\ No newline at end of file
-- 
Gitee