快速开始
项目简介
灵简(LingJian)是一个前后端分离的微服务架构项目。项目分为两个仓库：
- 后端项目：lingjian
- 前端项目：lingjianui
环境要求
在开始之前，请确保您的开发环境满足以下要求：
| 软件 | 版本要求 | 说明 |
|---|---|---|
| Go | 1.20+ | 后端开发环境 |
| Node.js | 22.11.0 | 前端开发环境 |
| MySQL | 8.0+ | 数据库服务 |
| Redis | 6.0+ | 缓存服务 |
| RabbitMQ | 3.8+ | 消息队列服务 |
项目初始化
1. 创建工作目录
mkdir lingjian && cd lingjian
# 克隆前后端项目
git clone https://github.com/iiwish/lingjian
git clone https://github.com/iiwish/lingjianui
2. 后端服务配置
cd lingjian
# 1. 安装项目依赖
make deps
# 2. 配置服务
cp config/config.yaml.example config/config.yaml
# 编辑 config.yaml，配置数据库、Redis、RabbitMQ等信息
# 3. 初始化数据库
make init-db
# 4. 启动服务
# 确保 MySQL、Redis、RabbitMQ 服务已启动
# 开发模式（支持热重载）
make dev-server
# 或者生产模式
make run-server # API服务
make run-worker # 后台任务处理器
3. 前端服务配置
cd lingjianui
# 1. 安装依赖
npm install
# 2. 环境配置
cp .env.example .env
# 编辑 .env 文件，配置API地址等信息
# 3. 启动服务
# 开发模式
npm run dev
# 或者生产模式
npm run build
npm start
访问服务
- 后端API服务默认地址：http://localhost:8080
- 前端页面默认地址：http://localhost:3000
常见问题
如遇到问题，请查看：
- 确保所有依赖服务(MySQL、Redis、RabbitMQ)已正确启动
- 检查配置文件中的连接信息是否正确
- 查看服务日志获取详细错误信息