项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-09-12 · 当前星标 ★ 11842
使用教程
环境要求
- 已安装 Bun 运行时(bun.com)
- 已安装 Docker 与 Docker Compose
- 本机可访问 5432、3000、3001 端口
- Node 生态常规开发环境(TypeScript 项目)
安装与启动步骤
-
1克隆仓库
从 GitHub 拉取默认分支 release,即最新打标签的发布版本,随后进入项目目录。
git clone https://github.com/trycompai/crm.git && cd crm -
2生成环境文件
复制 .env.example 为仓库根目录的 .env,再按下方配置项填入真实值。
cp .env.example .env -
3安装依赖
用 Bun 安装项目依赖,Bun 与 Docker 是快速开始的必需前置条件。
bun install -
4启动数据库
用 Docker Compose 拉起 Postgres,容器内映射到本机 5432 端口。
docker compose up -d -
5执行数据库迁移
把迁移脚本应用到刚启动的 Postgres,建好项目所需的表结构。
bun run db:deploy -
6导入示例数据
可选步骤:写入一份看起来真实的销售管道数据,方便直接体验界面。
bun run db:seed -
7启动开发服务
同时启动应用、API 与智能体三个进程,日志会在当前终端持续输出。
bun run dev
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
DATABASE_URL | 是 | 三个进程共用的数据库连接串,默认指向本地 5432 的 Postgres。 | postgresql://postgres:postgres@localhost:5432/crm |
BETTER_AUTH_SECRET | 是 | API 签发会话 Cookie、应用校验 Cookie 所用的密钥,两端必须一致。 | your-random-long-secret |
API_URL | 否 | API 对外的访问地址,仅在非 localhost 部署时需要设置。 | http://localhost:3001 |
APP_URL | 否 | 前端应用的对外访问地址,仅在非 localhost 部署时需要设置。 | http://localhost:3000 |
PERPLEXITY_API_KEY | 否 | 让智能体能够检索公开网页并附带引用来源。 | pplx-xxxxxxxx |
CRON_SECRET | 否 | 保护邮箱同步接口;不设置则无法使用该同步路由。 | your-cron-secret |
如何确认成功
浏览器打开 localhost:3000 能看到应用界面,接口服务在 localhost:3001 正常响应,终端无迁移报错。
常见问题
Q:必须同时装 Bun 和 Docker 吗?
A:是。README 明确快速开始需要 Bun 与 Docker;Docker 用于拉起 Postgres,Bun 用于安装依赖和运行脚本。
Q:应该用 release 还是 main 分支?
A:直接运行选 release,它是默认分支也是最后一个打标签的发布版;main 是未发布的开发分支,只有准备提 PR 时才切过去。
Q:部署后一直跳转循环怎么办?
A:说明 DATABASE_URL 或 BETTER_AUTH_SECRET 两端不一致。API 签发的会话 Cookie 需要应用端能校验,建议分别放在不同子域并设置 AUTH_COOKIE_DOMAIN。
Q:邮箱同步怎么保持运行?
A:设置 CRON_SECRET,然后用调度器定时请求 POST /internal/sync/mailboxes;没有该密钥时这个路由不可用。
Q:怎么彻底关闭数据上报?
A:把 CRM_TELEMETRY_DISABLED 设为 1,或设置 DO_NOT_TRACK,本次安装就不会上报任何信息。
注意事项
- 仓库根目录只有一个 .env,被应用、API、智能体三个进程共同读取;真实环境变量优先级更高,托管平台上直接配环境变量即可。
- apps/api/src/generated/server.ts 已提交到仓库,build 过程不要再生成它;本地重新生成后需要连同路由改动一起提交。
- 除必需项外的配置全部可选,不填也能正常启动。
- 生产部署要把 API_URL、APP_URL 设为真实域名,并把 /api/auth/callback/google(及微软回调)加入服务商的重定向 URI。
核心亮点
- 以智能体为核心设计,AI 可直接操作 CRM 数据,而非仅做聊天外壳
- TypeScript 技术栈,前后端统一,便于开发者二次开发和集成
- 开源可自托管,数据自主可控,适合对隐私敏感的团队
不足之处
- 面向 AI 智能体的交互范式较新,传统销售团队上手需要适应
- 作为 CRM 在报表、权限、审批等企业级功能上可能不如成熟商业产品完善
适用场景
- 销售团队用 AI 智能体自动整理线索并生成跟进任务
- 开发者把 CRM 作为智能体工具链中的客户数据层进行集成
- 中小企业自托管一套带 AI 自动化的轻量 CRM 系统
替代项目
Twenty、Odoo
上一篇:notfair-plugin
下一篇:investorskills
同类项目推荐
MedicalNet
开源
小样本医学影像,用预训练3D-ResNet直接微调提精度
Many studies have shown that the performance on deep learning is significantly affec···
GenAI4AD
开源
一张图看懂生成式AI如何重塑自动驾驶全栈
a comprehensive and critical synthesis of the emerging role of GenAI across the full···
Crow-Eye
开源
用 AI 自动挖 Windows 取证痕迹,快速出报告
Windows forensics Engine
NoveLA
开源
安卓上聚合 25+ 源,看轻小说还能离线、翻译和听书
Free Android reader for web novels, light novels, ranobe, webtoons & EPUB, FB2. 25+ ···
numerblox
开源
快速搭建标准化 Numerai 预测管道,专注模型调优
Solid Numerai pipelines
批量处理医学切片,边看边标边训练模型
Facilitates simple large scale processing of HLS Medical images, documents, zip file···
AI-OPS
开源
用自然语言对话,让 AI 帮你打渗透测试。
Penetration Testing AI Assistant based on open source LLMs.
redcell
开源
让 AI 智能体在 Kali 里自动跑完渗透测试并出报告
AI red-team platform. Autonomous LLM agents run a penetration test end to end inside···
NBA-Machine-Learning-Sports-Bett···
开源
用机器学习预测NBA赛果,让博彩决策有数据支撑
NBA sports betting using machine learning
