diff --git a/README.md b/README.md index b9dd917..9db89cf 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ # OpenGPTs OpenGPTs 是一款开源的浏览器插件,支持语音输入,函数调用,多模型,多模态,批量对话,网页端或者APIKey调用模型
-我们希望这款插件可以帮助你更高效的使用GPT,甚至未来代替你控制网页,实现各种RPA操作
+我们希望这款插件可以帮助你更高效的使用GPT,甚至未来代替你控制网页,实现各种机器人自动化(RPA)操作
**简体中文** · [Enlish](./README_EN.md) · [Changelog](./changeLog.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
@@ -50,6 +50,8 @@ OpenGPTs 是一款开源的浏览器插件,支持语音输入,函数调用,多 - 下载: [插件链接]("https://github.com/hzeyuan/OpenGPTS/releases/download/v0.0.1-beta/OpenGPTs.v0.0.3.zip") - 问题: 有任何需求或者问题可以到[issues][github-issues-link]上提问,我们会积极处理并解决的。 - 开发: 👏🏻欢迎任何小伙伴参与进来,关于开发可以查看 [这里](#开发指导) +- 联系方式: 请加入我们的QQ群:860859251,邮箱:yixotieq@gmail.com + **野望**:我们的最终设想是希望能够以这个插件为平台📈,把**每个GPTs当成一个Agent**🤖,实现各种业务流程的自动化,最大程度解放大家的生产力🚀,帮助大家更好的摸鱼🐟!哈哈!😄 @@ -320,6 +322,8 @@ ChatGPT很厉害,但ChatGPT的产品交互我觉得可以做的更好,甚至 ## 开发指导: +详细请查看[开发文档](./SETUP.md) + ### 安装 #### 复制项目到指定目录: diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 0000000..c7afb2d --- /dev/null +++ b/SETUP.md @@ -0,0 +1,80 @@ +### 技术栈 + +#### 本项目使用以下技术栈 + +* [tailwindcss](https://tailwindcss.com/docs) +* [nextjs](https://nextjs.org/docs/getting-started) +* pnpm +* typescript +* [react](https://reactjs.org/docs/getting-started.html) +* [plasmo](https://docs.plasmo.com/) +* [ant-design](https://ant.design/docs/react/introduce-cn) + +### 项目架构 + +项目是mono repo,使用pnpm管理,目录结构如下: + +``` +├── README.md +├── README_EN.md +├── SETUP.md +├── apps +├── changeLog.md +├── images +├── node_modules +├── package.json +├── packages +├── pnpm-lock.yaml +├── pnpm-workspace.yaml +├── tsconfig.json +└── turbo.json +``` + +#### apps目录 +* apps/website: 项目的网站,包括主页、文档、博客等 +* apps/extensions: 项目的浏览器插件,包括Chrome、Firefox等 + +#### packages目录 +存放项目的公共模块,例如: + +* packages/@opengpts 项目的核心包,包括对话管理、对话消息发送、对话状态查询等 +* packages/typescript-config 项目的ts配置 +* packages/tailwind-config 项目的tailwind配置 +* packages/eslint 项目的eslint配置 +* packages/types 项目的公共类型定义 +其他共享模块 + +## 应用 + +- apps/website: 项目的网站,包括主页,文档,博客等 +- apps/extensions: 项目的浏览器插件,包括chrome,firefox等 + + + +### 插件开发 + +插件是基于[plasmo]框架(https://docs.plasmo.com/)开发,如果需要了解插件的开发流程,可以参考[plasmo文档](https://docs.plasmo.com/)。插件的开发流程如下: + +1. 在根目录下执行命令,安装依赖 + +```bash +pnpm i +``` + +2. 启动插件 + +```bash +pnpm run dev:ext +``` + +会在app/extensions/build目录下生成插件的文件,然后在chrome浏览器中加载插件即可。 + +### 网站开发 + +1. 启动网站 + +```bash +pnpm run dev:web +``` + +标准的nextjs应用,需要了解nextjs的开发流程, 可以参考[Next.js Documentation](https://nextjs.org/docs/getting-started)