# openscrm-api-server
**Repository Path**: mywisdomcode/openscrm-api-server
## Basic Information
- **Project Name**: openscrm-api-server
- **Description**: openscrm的api-server
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-31
- **Last Updated**: 2024-05-31
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
重要：本项目缺乏维护，目前没有力量继续维护，如果有兴趣维护的朋友，可以联系我，我会尽力提供帮助。
安全，强大，易开发的企业微信SCRM
文档 |
[截图](#项目截图) |
演示 |
安装
### 项目简介
> OpenSCRM是一套基于**Go**和**React**的**高质量**企业微信私域流量管理系统
### 快速开始（docker-compose）
我们依靠docker-compose启动mysql和redis。
api-server后端API本地编译启动，
dashboard前端界面同样本地编译启动
#### 启动mysql和redis
docker-compose up
#### 启动api-server
* conf/config.example.yaml -> conf/config.yaml // 修改SuperAdmin字段就行了，其他的跑起来再改
* 项目根目录下启动 go run main.go
* api监听地址 http://localhost:9001/
#### 启动前端dashboard
* git clone https://github.com/openscrm/dashboard
* 安装 16.20.2 版本的nodejs，只能是这个版本，其他版本会有兼容问题，推荐用nvm管理node版本
* 可选，安装国内npm包镜像源，参考https://npmmirror.com/
* npm install --legacy-peer-deps
* npm run start
#### 访问站点
http://localhost:9000/
#### 常见问题
##### 前端无法连接后端api-server.
检查nginx配置 docker/nginx/conf/conf.d/dashboard.conf
##### 容器中运行的程序如何链接宿主机
docker中宿主机ip地址为172.17.0.1，所有docker服务默认监听端口到宿主机上，配置文件中需要填host的地方填172.17.0.1
##### 登录界面出现提示：redirect_uri 与配置的授权完成回调域名不一致
企业微信扫描登录需要配置回调地址和授权登录地址
### 搭建开发环境(可选)
#### 安装go语言环境
https://go.dev/doc/install
#### 安装swag
```
go install github.com/swaggo/swag/cmd/swag@latest
```
#### 启动程序
```
go run main.go
```
#### 访问站点
http://dashboard.dev.openscrm.cn:9000/
### 子项目
[会话存档服务](https://github.com/openscrm/msg-server)
[管理面板](https://github.com/openscrm/dashboard)
[企业微信H5侧边栏](https://github.com/openscrm/sidebar)
### 项目特点
* **安全性高**：企业微信控制了企业所有员工和客户的敏感数据，如电话号码，职位，客户标签，联系方式等，如果发生泄露，
对企业的打击将是致命的。我们团队有丰富的Web安全经验保证项目安全性。
* **高性能，高稳定性**：得益于Go出色的工程能力，简单有效的并发控制能力，OpenSCRM具备比肩头部Saas厂商的高性能和高稳定
* **代码可读性优先**：我们深刻认同Google对于代码管理的看法，项目开发完成只是项目的开始，更多的工作在于维护和迭代，
唯有易读的代码才能保证后期迭代的高质量，高效率，这也是Go语言的设计目标。我们有非常完善的代码注释，所有代码力求清晰易读。
* **易开发**：作为开源项目，我们为了让更多的人可以受益于此项目，我们做了大量工作力求项目简单易上手。
我们只做必要抽象（MVC），避免引入新慨念。我们坚持尽量少的中间件依赖，仅依赖Mysql和Redis，
比如延迟队列我们基于Redis实现， 没有引入Kafka；比如全文检索基于Mysql8全文检索实现，没有引入ES。
> Python，PHP，NodeJS开发者可以放心使用本项目，本项目做了大量工作力求简单，非常容易上手。
### 项目截图
### 技术栈
#### 后端技术栈
* [Go](https://learnku.com/docs/the-way-to-go)
* [Gin](https://learnku.com/docs/gin-gonic/2019)
* [GORM](https://gorm.io/zh_CN/docs/)
* Redis
* Mysql >= 5.7
#### 前端技术栈
* [React](https://zh-hans.reactjs.org/)
* [TypeScript](https://www.tslang.cn/docs/handbook/typescript-in-5-minutes.html)
* [Ant Design](https://ant.design/components/overview-cn/)
* [Ant Design Pro](https://pro.ant.design/zh-CN/docs/overview)
* [Pro Components](https://procomponents.ant.design/components)
### 目录结构
```
├─app
│ ├─callback 企业微信事件回调处理
│ │ ├─customer_event
│ │ ├─department_event
│ │ ├─group_chat_event
│ │ ├─msg_arch_event
│ │ ├─staff_event
│ │ └─tag_event
│ ├─constants 常量定义
│ ├─consumers 队列消费
│ ├─controller 控制器
│ ├─entities 消息实体，主要定义参数，请求，响应结构体
│ ├─middleware gin请求中间件
│ ├─models 数据库模型
│ ├─requests 请求定义
│ ├─responses 响应定义
│ ├─services 服务
│ ├─tasks 定时任务
├─bin 二进制文件
├─common 共同库
│ ├─app 基于Gin封装的常用请求响应处理函数
│ ├─delay_queue 基于Redis延迟队列
│ ├─ecode 错误码
│ ├─id_generator uuid生成
│ ├─log 日志
│ ├─redis redis操作库
│ ├─session session会话
│ ├─storage 存储
│ ├─util 常用工具函数
│ └─validator 请求验证
├─conf 配置文件
├─docker
│ ├─data
│ │ ├─dashboard
│ │ │ └─dist 管理后台构建的前端静态文件
│ │ ├─mysql
│ │ │ ├─conf mysql容器配置文件
│ │ │ └─db mysql容器数据文件
│ │ ├─nginx
│ │ │ ├─conf nginx容器配置文件
│ │ │ │ └─conf.d
│ │ │ └─logs
│ │ ├─redis
│ │ │ └─db redis容器数据文件
│ │ └─sidebar
│ │ └─dist 侧边栏构建的前端静态文件
│ └─lib 企业微信提供的会话存档动态链库
├─docs 文档
├─pkg 三方库
│ └─easywework 企业微信Api调用库
│ ├─errcodes 企业微信Api错误码
├─routers Gin路由
├─scripts 脚本
└─test 测试代码
```
### 安装教程
https://github.com/openscrm/api-server/wiki/%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B
### Api调试
`docs目录包含postman导出文件，可方便调试api`
### 版权声明
OpenSCRM遵循Apache2.0协议，可免费商用