@bee-hole/server/README.md

www.bee-hole.com

# XBuy Backend

XBuy是一个基于Go语言开发的电商后端系统，使用GoFrame框架构建。

## 项目结构

```
xbuy-backend/
├── addons/          # 插件目录
├── app/             # 应用核心代码
│   ├── logic/       # 业务逻辑层
│   │   ├── admin/   # 管理后台逻辑
│   │   ├── api/     # API接口逻辑
│   │   ├── mall/    # 商城相关逻辑
│   │   ├── oauth/   # 认证授权逻辑
│   │   └── sys/     # 系统功能逻辑
├── boot/            # 启动初始化相关
├── config/          # 配置文件目录
├── doc/             # 文档目录
├── docker/          # Docker相关配置
├── i18n/            # 国际化资源
├── internal/        # 内部私有代码
├── pkg/             # 公共包
├── resource/        # 资源文件
├── router/          # 路由配置
├── runtime/         # 运行时数据
├── storage/         # 存储目录
├── test/            # 测试代码
├── tools/           # 工具脚本
├── utility/         # 工具函数
└── xerror/          # 错误处理

## 主要功能

- 用户认证与授权
- 商城管理
- 订单系统
- 多语言支持
- Redis缓存支持
- MySQL数据库支持

## 技术栈

- 框架：GoFrame v2
- 数据库：MySQL
- 缓存：Redis
- 认证：JWT

## 开发环境要求

- Go 1.16+
- MySQL 5.7+
- Redis 6.0+

## 快速开始

1. 克隆项目
```bash
git clone [项目地址]
```

2. 复制配置文件
```bash
cp config/config.example.yaml config/config.yaml
```

3. 修改配置文件
根据实际环境修改 `config/config.yaml` 中的配置

4. 运行项目
```bash
go run main.go
```

## 部署

项目支持Docker部署，相关配置文件在 `docker` 目录下。

## 文档

详细的API文档和开发指南请参考 `doc` 目录。