chore: settle product naming across app, widget and deployments
One word everywhere: ReplyPier in UI copy, package and image names, the replypier.site domains (app/api/docs/help), REPLYPIER_* settings and the --rp-* design tokens. - public widget API is window.ReplyPier with replypierId / replypierBaseUrl / replypierConfig / replypierToken, loader at webclient/replypier.min.js; both bundles rebuilt from source - NOTICE, llms.txt, CONTRIBUTING, HELP_CENTER_INFRA and the demo runtime config rewritten; the demo config ships no third-party keys - migration adds the ReplyPier managed model value to the AI model enum - local compose project, database, role, volume and Docker network carry the same name
This commit is contained in:
WangShen007 committed
1 parent
ff0a09f0e5
commit
20fef2b9f3
1156 files changed
+7267
-7148
No files matched your search
@@ -1,49 +1,54 @@
|
||||
# ChatterMate
|
||||
# ReplyPier
|
||||
|
||||
> ChatterMate is an open-source AI customer-support chatbot platform. You can sign up, create AI
|
||||
> agents, add knowledge sources, and embed a chat widget — all from a browser, the terminal (CLI),
|
||||
> or programmatically via an AI agent over MCP.
|
||||
> ReplyPier 是一个开源的 AI 客服系统：AI 先依据知识库答疑，转人工后在同一个会话里接着处理，
|
||||
> 服务结束邀请访客评价。仓库包含后端、客服工作台、嵌入 Widget、帮助中心与端到端测试。
|
||||
|
||||
## Start here (AI agents & automation)
|
||||
## 仓库
|
||||
|
||||
Use the **ChatterMate CLI** (the `chattermate` command, installed with `pip install chattermate-cli`)
|
||||
to sign up and manage everything from the terminal. It is the account/config CLI — distinct from the
|
||||
self-host Docker tool (`npm install -g chattermate-deploy`).
|
||||
- 源码：http://149.71.241.228:10489/WangShen007/replypier
|
||||
- 分支：`main`
|
||||
|
||||
Minimal end-to-end flow:
|
||||
## 本机运行
|
||||
|
||||
需要 PostgreSQL 16 + pgvector、Redis、Python 3.12 与 Node：
|
||||
|
||||
```bash
|
||||
pip install chattermate-cli
|
||||
chattermate signup --name "Acme Inc" --domain acme.com --admin-email you@acme.com --admin-name "You"
|
||||
chattermate agent create --name "Support" --type customer_support -i "Be concise" --json
|
||||
# Add knowledge from a URL or a local PDF:
|
||||
chattermate knowledge add-url --website https://docs.acme.com --agent-id <agent-id>
|
||||
chattermate knowledge add-file ./guide.pdf --agent-id <agent-id>
|
||||
# Create a widget to get the embed id:
|
||||
chattermate widget create --agent-id <agent-id> --name "Website widget"
|
||||
# Embed on your site:
|
||||
# <script>window.chattermateId='YOUR_WIDGET_ID';</script>
|
||||
# <script src="https://app.chattermate.chat/webclient/chattermate.min.js"></script>
|
||||
./deploy/local/local.sh setup # 首次运行：安装依赖并构建前端
|
||||
./deploy/local/local.sh up # 启动数据库、后端与前端
|
||||
./deploy/local/local.sh status # 查看各服务状态
|
||||
```
|
||||
|
||||
## Docs
|
||||
- 客服工作台：http://127.0.0.1:3018/
|
||||
- 悬浮客服演示页：http://127.0.0.1:3018/local-demo.html
|
||||
- 部署、账号与恢复说明：`LOCAL_DEPLOY.md`
|
||||
|
||||
- [AI Agent & Automation Quickstart](https://docs.chattermate.chat/features/agents-quickstart): copy-paste path from signup to a live widget, built for AI agents and CI.
|
||||
- [CLI reference](https://docs.chattermate.chat/features/cli): the account CLI — signup, login, tokens, agents, workflows, knowledge.
|
||||
- [MCP Server](https://docs.chattermate.chat/features/mcp-server): let an AI agent configure ChatterMate over the Model Context Protocol (`chattermate-mcp`).
|
||||
- [Quickstart](https://docs.chattermate.chat/quickstart): hosted vs self-host, side by side.
|
||||
- [Widget integration](https://docs.chattermate.chat/features/widget): embed the chat widget on any site.
|
||||
- [Widget Apps & API keys](https://docs.chattermate.chat/features/widget-apps): authenticated widgets and programmatic tokens.
|
||||
## 网站接入
|
||||
|
||||
## Key URLs
|
||||
在后台创建一个 Widget 拿到 id，然后在页面里引入加载器：
|
||||
|
||||
- Sign up / dashboard: https://app.chattermate.chat
|
||||
- Hosted API base: https://api.chattermate.chat (routes under `/api/v1`)
|
||||
- Widget script: https://app.chattermate.chat/webclient/chattermate.min.js
|
||||
- Documentation: https://docs.chattermate.chat
|
||||
- GitHub: https://github.com/chattermate/chattermate.chat
|
||||
```html
|
||||
<script>window.replypierId = "YOUR_WIDGET_ID";</script>
|
||||
<script src="https://<你的域名>/webclient/replypier.min.js" async></script>
|
||||
```
|
||||
|
||||
## Self-hosting (optional)
|
||||
自建实例的域名即后端或前端对外地址；加载器默认读取 `window.replypierBaseUrl`，
|
||||
未设置时用构建时写入的 API 地址。站点已登录用户可用
|
||||
`window.ReplyPier.identify(token)` 把访客身份绑定到自己的账号。
|
||||
|
||||
- [Self-host with Docker](https://docs.chattermate.chat/quickstart#option-b-self-host-with-docker): run the full stack on your own infrastructure with the self-host CLI (`npm install -g chattermate-deploy`, command `chattermate-deploy init/start/stop`).
|
||||
- [Docker deployment](https://docs.chattermate.chat/deployment/docker)
|
||||
## 代码结构
|
||||
|
||||
- `backend/app/`：FastAPI 应用、Agent、知识处理、工单与后台任务
|
||||
- `backend/tests/`：后端测试
|
||||
- `frontend/src/`：管理后台、客服工作台与嵌入 Widget
|
||||
- `frontend/src/webclient/replypier.js`：网站加载器源码，构建到 `frontend/public/webclient/replypier.min.js`
|
||||
- `e2e/`：Playwright 端到端测试，约定见 `e2e/AUTHORING.md`
|
||||
- `deploy/local/`：本机环境与启停脚本
|
||||
|
||||
## 技术栈
|
||||
|
||||
Python、FastAPI、SQLAlchemy、Alembic、PostgreSQL/pgvector、Redis、Agno；
|
||||
Vue 3、TypeScript、Vite、Socket.IO。
|
||||
|
||||
## 许可
|
||||
|
||||
Apache License 2.0，见 `LICENSE` 与 `NOTICE`。
|
||||
Reference in new issue
Block a user