evolution-api

环境要求

• Node.js 与 npm 环境（用于执行 npm install / build / start:prod）
• 一个可连接的数据库（README 提到执行 migrations，未指明具体数据库类型）
• Docker（如使用官方镜像部署方式）
• 可访问 GitHub 与 npm 源 / Docker Hub 的网络环境

安装与启动步骤

1. 1克隆项目仓库

   README 使用的是 SSH 地址，需本机已配置 GitHub SSH 密钥，克隆后进入项目目录。

   git clone git@github.com:evolution-foundation/evolution-api.git
   cd evolution-api

   复制

2. 2安装依赖

   在项目根目录执行，安装 package.json 中声明的全部依赖。

   npm install

   复制

3. 3准备环境变量文件

   README 的 Docker 命令通过 --env-file .env 读取配置，需先在项目根目录准备好 .env 文件，具体变量见官方文档。

4. 4执行数据库迁移

   README 的 Database setup 步骤，通过 npm 脚本部署数据库结构，需数据库已可连接。

   npm run db:deploy

   复制

5. 5构建并启动服务

   README 的生产运行方式：先构建，再以 prod 模式启动服务。

   npm run build
   npm run start:prod

   复制

6. 6或用 Docker 部署

   拉取官方镜像并以 8080 端口启动，配置由 .env 文件注入。

   docker pull evoapicloud/evolution-api:latest
   docker run -p 8080:8080 --env-file .env evoapicloud/evolution-api:latest

   复制

关键配置

如何确认成功

服务启动后监听 8080 端口（镜像映射 -p 8080:8080），可访问 http://localhost:8080 确认接口可用。

常见问题

注意事项

• README 仅给出快速开始命令，完整配置项请查阅官方文档 https://docs.evolutionfoundation.com.br
• Docker 方式默认映射宿主 8080 端口，如被占用需调整端口映射
• 生产环境运行需先执行构建，不要遗漏 npm run build
• 官方镜像为 evoapicloud/evolution-api:latest，社区与支持入口见 evolutionfoundation.com.br