webwhiz

环境要求

• Docker 与 docker-compose（Docker 方式）
• Node.js 与 yarn、npm（本地安装方式）
• Python 3 与 python3-venv（运行 python worker）
• OpenAI API Key（OPENAI_KEY、OPENAI_KEY_2）

安装与启动步骤

1. 1克隆项目仓库

   从 GitHub 拉取 webwhiz 源码到本地，后续所有命令都在仓库根目录执行。

   git clone https://github.com/webwhiz-ai/webwhiz.git
   cd webwhiz

   复制

2. 2填写环境变量

   编辑仓库根目录下的 .env.docker 文件，填入自己的 OPENAI_KEY 和 OPENAI_KEY_2 两个密钥。

3. 3Docker 启动服务

   在仓库根目录执行 docker-compose，-d 表示以守护进程方式在后台运行整个服务栈。

   docker-compose up -d

   复制

4. 4安装 Node 依赖

   本地安装方式：在根目录用 yarn 安装 Node 依赖，为后续构建做准备。

   yarn install

   复制

5. 5安装 Python 依赖

   进入 workers 目录创建虚拟环境并激活，再安装 python worker 所需依赖。

   cd workers
   python3 -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt

   复制

6. 6构建并启动后端

   回到根目录构建项目，全局安装 pm2（需要时加 sudo），用 pm2 启动服务进程。

   cd ..
   yarn run build
   npm install -g pm2
   pm2 start ecosystem.config.js

   复制

7. 7启动前端应用

   安装前端依赖后运行前端开发服务；如需打包前端可执行 npm run build。

   npm install
   npm run start

   复制

关键配置

如何确认成功

README 未给出明确验证方式；pm2 启动后应能看到 backend http server、js worker 和 python worker 均在运行。

常见问题

注意事项

• 遇到安装问题可按 README 提示发邮件到 hi@webwhiz.ai。
• npm install -g pm2 在部分系统需要加 sudo 才能全局安装。
• 改动 .env.docker 后需重新执行 docker-compose 才会生效。
• python worker 必须在激活的虚拟环境中安装依赖。