# ubdframe

**Repository Path**: captials-team/ubdframe

## Basic Information

- **Project Name**: ubdframe
- **Description**: 通用业务框架（Universal business design）
以相对通用的业务逻辑适用于日常用到的业务模块，可以此作为基础搭建的框架
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-06
- **Last Updated**: 2026-02-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ubdframe

## 介绍
ubdframe 是一个基于 Go 语言的通用后台开发框架，提供了一整套开箱即用的功能模块。框架采用模块化设计，结合 Gin 和 gRPC，支持 RESTful API 和 WebSocket 服务，适用于构建高效、可扩展的后端服务。

## 安装教程
1. 确保已安装 Go 环境（建议 Go 1.18+）。
2. 克隆项目：
   ```bash
   git clone https://gitee.com/captials-team/ubdframe
   ```
3. 安装依赖：
   ```bash
   go mod download
   ```

## 项目结构
- `cmd`：入口文件
- `src/common`：通用常量、工具函数
- `src/domain`：业务模型、请求/响应结构体
- `src/infrastructure`：基础设施层，包括缓存、数据库、消息队列等
- `src/pkg`：通用组件，如 JWT 鉴权、日志、指标等
- `src/resource`：资源文件，如测试用数据、区域数据、Swagger UI 等



## 开发与测试
- 单元测试位于各模块的 `_test.go` 文件中
- 使用 `go test` 运行测试
- 支持依赖注入（`dig`）和服务注册

## 贡献
欢迎提交 PR 或 Issue。请遵循开源协议并保持代码风格统一。