# 天天红包-api

**Repository Path**: yunchuang-team_1/daily-red-envelope-backend

## Basic Information

- **Project Name**: 天天红包-api
- **Description**: 天天红包客户端接口服务
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-27
- **Last Updated**: 2025-10-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目介绍
天天红包APP端 - API接口

## 安装
安装 **go1.20** 及以上版本

启用 go mod 包管理工具**export GO111MODULE=on**

`go env -w GOPROXY=https://goproxy.cn,direct`

`go mod tidy`

## 开发规范
### 常用字段名
- 金额、余额（单位：分,int）：amount
- 金豆数（单位：个,int64）：bonus
- 提现：withdraw
- 到账：arrival
- 收益、获利、回报（单位：元,float64）：reward
- 分佣：divide
- 直邀下级：sub_user
- 间邀下级：sec_sub_user
- 直邀上级：up_user
- 间邀上级：sec_up_user

## git规范

- feat：新增功能
  - 格式：feat/251010-new_feat_name
- fix：bug 修复
- docs：文档更新
- ref：重构代码(既没有新增功能，也没有修复 bug)
- perf：性能, 体验优化
- test：新增测试用例或是更新现有测试

## 环境

1. 本地 local
2. 测试 test
3. 预发布 stage
4. 生产 release

## 项目结构

```
.
├── README.md
├── cmd     //定时 常驻
├── conf    //项目配置文件 (local/test/release)
│   ├── local.yaml
│   ├── test.yaml
│   └── release.yaml
├── docs    //项目相关文件
│   ├── Air热加载.md
│   └── 项目规范.md
├── internal/
│   ├── api/             // API接口定义层，处理HTTP请求入口
│   ├── business/        // 业务逻辑层，封装核心业务流程
│   ├── common/          // 公共组件，提供跨模块共享功能
│   │   ├── config/         // 配置相关组件
│   │   ├── entity/         // 实体定义
│   │   ├── errno/          // 错误码定义和处理
│   │   ├── global/         // 全局变量和常量
│   │   └── uctx/           // 用户上下文管理
│   ├── entity/          // 数据实体定义，包含系统核心数据结构
│   │   ├── cache/          // 缓存相关实体
│   │   └── define/         // 业务层核心定义
│   ├── logic/           // 逻辑处理层，实现具体业务逻辑
│   ├── middleware/      // HTTP中间件
│   ├── model/           // 数据模型层，数据库表结构映射
│   ├── constant/        // 常量定义
│   ├── request/         // 请求参数定义，规范API输入数据结构
│   ├── response/        // 响应数据定义，规范API输出数据结构
│   ├── router/          // 路由配置，定义API路由和处理函数映射
│   └── timer/           // 定时任务实现，处理周期性任务
│       ├── day_count/      // 每日统计相关任务
│       ├── logs/           // 日志处理相关任务
│       ├── monitor/        // 监控相关任务
│       ├── order/          // 订单相关定时任务
│       └── user/           // 用户相关定时任务
├── pkg/                 // 公共组件
├── scripts/             // 通用脚本
└── main.go

```