diff --git a/website/docs/deployment/dev.md b/website/docs/deployment/dev.md index 66e861c9..af05bd72 100644 --- a/website/docs/deployment/dev.md +++ b/website/docs/deployment/dev.md @@ -40,3 +40,27 @@ You can edit the configuration of `server/.env` to your own relevant context The file can be started from `server/.env.example` Now you can preview your server in `http://localhost:11011` + +## Project directory description + +- `apps`: non-core applications + - `cli`: Tailchat’s command line program + - `github-app`: Tailchat’s github integration bot + - `oauth-demo`: Tailchat open platform third-party login demo program + - `widget`: Web page embedded widget +- `client`: client + - `desktop`: desktop version + - `mobile`: mobile version + - `packages`: dependency packages + - `shared`: platform-independent common code + - `web`: web version + - `plugins`: pure frontend plugins + - `src`: source code +- `packages` + - `types`: common types for both front and back ends +- `server`: server + - `admin`: background management + - `models`: database model + - `plugins`: server-side plugins + - `services`: microservices +- `website`: official website diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/dev.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/dev.md index f1c1ebca..de890a08 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/dev.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/dev.md @@ -40,3 +40,28 @@ pnpm dev 该文件可以从 `server/.env.example` 开始 现在你可以在 `http://localhost:11011` 访问你的 Tailchat 服务了 + +## 项目目录说明 + +- `apps`: 非核心应用 + - `cli`: Tailchat 的命令行程序 + - `github-app`: Tailchat 的github集成机器人 + - `oauth-demo`: Tailchat 开放平台第三方登录演示程序 + - `widget`: 网页嵌入小部件 +- `client`: 客户端 + - `desktop`: 桌面端 + - `mobile`: 移动端 + - `packages`: 依赖包 + - `shared`: 平台无关的通用代码 + - `web`: 网页端 + - `plugins`: 纯前端插件 + - `src`: 源码 +- `packages` + - `types`: 前后端通用类型 +- `server`: 服务端 + - `admin`: 后台管理 + - `models`: 数据库模型 + - `plugins`: 服务端插件 + - `services`: 微服务 +- `website`: 官网 + \ No newline at end of file