# crm-manager

**Repository Path**: yuan1998/crm-manager

## Basic Information

- **Project Name**: crm-manager
- **Description**: crm-manager
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-12-20
- **Last Updated**: 2024-11-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 环境依赖
* php >= 8.0
* supervisor 
* crontab


### 安装
拉取项目
```bash
git clone https://gitee.com/yuan1998/crm-manager.git
#进入目录
cd {项目名称}
# 拉取开发的插件
git submodule update --init --recursive
# 安装依赖
composer install
# 复制 environment 文件
cp .env.example .env
# 生成app key
php artisan key:generate
```
配置environment
```dotenv
# 数据库配置
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=数据库名
DB_USERNAME=数据库用户
DB_PASSWORD=数据库用户密码
# ...
# 有用到队列
QUEUE_CONNECTION=sync
# ... 一些其他配置
# IP白名单: 限制IP访问,不填不限制
IP_WHITE_LIST=
# 如果为https,改为true
ADMIN_HTTPS=false
# DebugBar 插件,线上建议关闭
DEBUGBAR_ENABLED=false
# 后台开发工具,线上建议关闭
ADMIN_ENABLE_HELPER=false
# 后台地址 :  https://xxxx.com/admin
ADMIN_ROUTE_PREFIX=admin
```
初始化 + 填充基础数据
```bash
# 运行迁移文件
php artisan migrate
# 填充数据
php artisan db:seed --class=InitDatabaseSeeder
```
配置crontab
```
* * * * * cd {项目路径} && php artisan schedule:run >> /dev/null 2>&1
```
配置supervisor
```
[program:crm-manager]
process_name=%(program_name)s_%(process_num)02d
command=php {项目路径}/artisan queue:work --queue=default,clue_created --sleep=30 --tries=2
autostart=true
autorestart=true
numprocs=1
user=root
redirect_stderr=true
stdout_logfile={项目路径}/storage/logs/worker.log
```
配置nginx (略)

访问测试

# API
## 1. 前端提交线索
### 1.1 功能描述
提供前端将线索提交进来的接口
### 1.2 请求说明
> 请求方式：POST<br>
请求URL ：[/api/clue/input](#)
### 1.3 请求参数
字段       | 字段类型 | 字段说明         |必须
------------|------|--------------|----
phone       | int  | 手机号          |是
name       | string | 客户姓名         |否
source       | string | [来源](#来源说明) | 否
url       | string | 提交地址         | 是
question_data       | json | 问题内容         |否
ip       | string | Ip地址         |否
location       | string | 地址           |否
remark       | string | 备注           |否

### 1.4 返回结果
```json  
{
  "code": 0",
  "msg": "OK."
}
```
### 1.5 错误状态码
状态码       |说明
------------|-----------
10001       |来源或者URL为空！
10002       |错误的来源！
10003       |错误的电话号码！
10004       |Url为空！

## 2. 推广平台转发线索到本平台
### 2.1 功能描述
让推广平台转发线索到平台里面.目前适配的平台
* 飞鱼
* 基木鱼
* 广点通
* 快手
### 2.2 请求说明
> 请求方式：ANY<br>
请求URL ：[/api/clue/access_clue](#)
### 2.3 请求参数
字段| 字段类型 |字段说明|必须
-----|------|-----|-----
source| int  |[来源](#来源说明)|是
### 2.4 返回结果
```json  
{
  "code": 0,
  "msg": "success"
}
```

### 来源说明
参数| 
-----|
百度|
基木鱼|
巨量|
飞鱼|
快手|
腾讯|
广点通|
OPPO|
VIVO|
UC|