快速入门 · 更新于 2026-10-27

快速开始与环境要求

了解 CatCRM 的运行环境要求、目录结构以及本地前后端开发启动方式。

系统简介

CatCRM 是一套基于现代主流技术栈研发的企业级全流程客户关系管理系统(CRM)。系统围绕 B2B 销售核心场景设计,完整覆盖线索、客户、公海池、联系人、跟进记录、商机、产品、合同、销售订单、回款计划与核销、发票管理以及动态自定义表单。

无论是采用官方 All-in-One Docker 镜像在 30 秒内完成私有化部署,还是基于全量源码进行深度二次开发,CatCRM 都能提供清晰、稳健的工程体验。

环境要求

在进行本地源码编译或开发环境搭建前,请确保宿主机满足以下版本要求:

组件 / 工具版本要求说明
Java (JDK)Java 25后端核心开发与运行环境(以 mvn -v 输出版本为准)
Maven3.9+后端依赖管理与打包工具
Node.js22.12+(或 20.19+)前端(frontend/)与官网(site/)开发与打包环境
PostgreSQL18核心关系型数据库,支持高性能事务与复杂统计查询
Redis8.10高速缓存与会话状态管理

提示:如果您仅需体验或生产部署 CatCRM,无需在宿主机手工安装上述环境,直接参阅 Docker 单容器部署 即可一键运行。

仓库目录结构

CatCRM/
├── backend/       # Spring Boot 4.1 + Java 25 后端工程
├── frontend/      # Vue 3.5 + Element Plus 2.14 + Vite 8 前端管理后台
├── site/          # Nuxt 3 + Nuxt UI v3 + Nuxt Content v3 官方网站与文档中心
├── deploy/        # Docker All-in-One 镜像构建、Nginx 配置与打包脚本
├── upload/        # 本地文件存储目录(图片、合同附件等)
└── logs/          # 系统运行日志目录

本地前后端开发启动

1. 启动后端服务 (backend/)

  1. 在本地 PostgreSQL 18 中创建空数据库 catcrm:
    CREATE DATABASE catcrm ENCODING 'UTF8';
    
  2. 修改 backend/src/main/resources/application-dev.yml 中的数据库连接与 Redis 密码配置。
  3. 启动后端主类,系统将通过 Flyway 自动按 V1 -> V3 顺序完成全部 33 张表结构、系统字典、管理员账号及 3217 条行政区划数据的初始化,无需手工导入任何 SQL 文件。
  4. 后端默认运行在 18080 端口,统一接口前缀(context-path)为 /api,接口文档地址为 http://localhost:18080/api/doc.html。

2. 启动前端管理后台 (frontend/)

cd frontend
npm install
npm run dev

前端开发服务器默认启动在 http://localhost:3000,Vite 会自动将 /api 前缀请求代理至本机 18080 端口的后端服务。

3. 默认登录账号

  • 管理员账号:admin
  • 默认密码:admin123