yi
c8e607c91c
CRM CI / build (push) Waiting to run
- Update default login email to xinmi@local.com - Update default password to 12345678 (and bcrypt hash in crm.sql) - Add example customers, products, and contracts to init SQL - Fix Docker env interpolation for VITE_API_BASE_URL - Hardcode local backend API URL in frontend .env files - Update README and docs to reflect new default credentials
111 lines
3.2 KiB
Markdown
111 lines
3.2 KiB
Markdown
# 灵犀客户通 (LingXi CRM)
|
||
|
||
<a href="#"><img src="https://img.shields.io/badge/版本-v1.0.0-blue.svg" /></a>
|
||
<a href="#"><img src="https://img.shields.io/badge/Go-1.21-00ADD8.svg" /></a>
|
||
<a href="#"><img src="https://img.shields.io/badge/Vue-3.0-4FC08D.svg" /></a>
|
||
<a href="#"><img src="https://img.shields.io/badge/License-MIT-green.svg" /></a>
|
||
|
||
## 📖 项目简介
|
||
|
||
**灵犀客户通（LingXi CRM）** 是一款专为中小企业设计的轻量级、全功能开放的客户关系管理系统。
|
||
系统采用前后端分离架构，后端基于高性能的 Go 语言（Gin 框架），前端使用现代化的 Vue 3 与 Vite 构建。
|
||
旨在为企业提供最直观、最快捷的客户管理体验，并且**没有任何功能限制（无需订阅高级版）**。
|
||
|
||
## ✨ 核心功能
|
||
|
||
- 👥 **客户管理**：全生命周期追踪客户信息，建立完善的客户档案。
|
||
- 📝 **合同管理**：在线管理商务合同，实时把控交付与回款进度。
|
||
- 📦 **产品管理**：统一维护产品库，支持多规格管理与库存关联。
|
||
- 📊 **仪表盘分析**：多维度数据可视化，一眼洞察销售业绩与客户增长。
|
||
- ⚙️ **系统配置**：一键配置邮件服务等系统级参数。
|
||
|
||
## 🛠️ 技术栈
|
||
|
||
### 后端 (Server)
|
||
- **开发语言**：Go 1.21
|
||
- **Web 框架**：Gin
|
||
- **ORM 框架**：GORM
|
||
- **数据库**：MySQL 8.0
|
||
- **缓存**：Redis
|
||
|
||
### 前端 (Web)
|
||
- **核心框架**：Vue 3
|
||
- **构建工具**：Vite
|
||
- **UI 组件库**：Ant Design Vue
|
||
- **图表库**：ECharts
|
||
|
||
## 🚀 快速部署 (Docker 推荐)
|
||
|
||
本项目已提供完整的 Docker 编排配置，推荐使用 Docker 一键部署：
|
||
|
||
### 1. 环境要求
|
||
- Docker
|
||
- Docker Compose
|
||
|
||
### 2. 一键启动
|
||
进入项目根目录，执行以下命令即可一键构建并启动所有服务（包括 MySQL、Redis、后端、前端）：
|
||
|
||
```bash
|
||
docker compose up -d --build
|
||
```
|
||
|
||
*(注意：首次启动会自动加载 `server/db/crm.sql` 初始化数据库)*
|
||
|
||
### 3. 访问系统
|
||
- **前端页面**：[http://localhost:11000](http://localhost:11000)
|
||
- **后端接口**：[http://localhost:11001/api](http://localhost:11001/api)
|
||
|
||
> **默认体验账号：**
|
||
> 邮箱：`xinmi@local.com`
|
||
> 密码：`12345678`
|
||
|
||
## 💻 本地开发环境
|
||
|
||
如果你希望在本地进行二次开发，请确保安装了以下环境：
|
||
- Go >= 1.21
|
||
- Node.js >= 18
|
||
- MySQL >= 8.0
|
||
- Redis >= 7.0
|
||
|
||
### 后端运行
|
||
```bash
|
||
cd server
|
||
go mod tidy
|
||
# 复制配置文件并根据本地环境修改
|
||
cp config.yaml config.dev.yaml
|
||
go run main.go
|
||
```
|
||
|
||
### 前端运行
|
||
```bash
|
||
cd web
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
|
||
|
||
### 截图
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## 📄 许可证
|
||
|
||
[MIT License](LICENSE)
|