# farkle

**Repository Path**: oneto7/farkle

## Basic Information

- **Project Name**: farkle
- **Description**: farkle小程序游戏
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-22
- **Last Updated**: 2026-02-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Farkle 项目

基于《天国：拯救2》经典投子（Farkle骰子）玩法开发的微信小程序。

## 📋 项目概述

### 项目类型
- **前端**: 微信小程序
- **后端**: Spring Boot 3.2.0 + Java 17
- **数据库**: MySQL
- **对象存储**: MinIO
- **缓存**: Redis

### 项目定位
还原原作核心玩法的同时，适配微信生态的轻量化、社交化场景，为玩家提供碎片化时间的娱乐体验。

## 🚀 快速开始

### 环境要求
- Node.js 14+
- Java 17+
- MySQL 5.7+
- 微信开发者工具

### 安装依赖

#### 后端
```bash
cd farkle_service
mvn clean install
```

#### 前端
```bash
cd farkle_mp
npm install
```

### 运行项目

#### 启动后端
```bash
cd farkle_service
mvn spring-boot:run
```

#### 启动前端
使用微信开发者工具打开 `farkle_mp` 目录

## 📁 项目结构

```
farkle/
├── farkle_mp/              # 微信小程序前端
│   ├── pages/              # 页面
│   ├── utils/              # 工具类
│   ├── audio/              # 音频文件
│   └── config/             # 配置文件
├── farkle_service/         # Spring Boot后端
│   └── src/main/java/com/ldq/farkle/
│       ├── controller/     # 控制器
│       ├── service/        # 服务层
│       ├── mapper/         # 数据访问层
│       ├── entity/         # 实体类
│       └── config/         # 配置类
├── docs/                   # 项目文档
└── target/                 # Maven构建输出
```

## 📚 文档

详细文档请查看 `docs/` 目录：

- **数据库文档** - `docs/database/`
- **项目报告** - `docs/reports/`
- **操作指南** - `docs/guides/`
- **设计文档** - `docs/design/`

完整文档索引：[docs/README.md](docs/README.md)

## 🎯 核心功能

### 已完成 ✅
- 用户系统（微信登录）
- 人机对战
- 好友对战（房间系统）
- 游戏记录保存
- 游戏统计
- 新手教程
- 成就系统
- 道具系统（基础功能）
- 排行榜系统
- 图片上传功能
- WebSocket实时通信

### 部分完成 ⚠️
- 道具系统（75%完成）
- 房间对战系统（85%完成）

### 待完成 ❌
- 好友系统
- 聊天系统
- 分享功能
- 观战系统
- 每日挑战系统
- 角色升级系统

## 📊 项目状态

### 完成度
- **总体完成度**: 约55%
- **数据库部分**: 95%
- **核心功能**: 85%
- **社交功能**: 30%

### 数据库状态
- **表结构**: 11个表 ✅
- **初始化数据**: 完整 ✅
- **基础索引**: 46个 ✅
- **性能优化索引**: 4个 ✅
- **健康度评分**: 95/100

## 🔧 技术栈

### 前端
- 微信小程序原生开发
- JavaScript
- WXML/WXSS

### 后端
- Spring Boot 3.2.0
- Spring Security
- Spring WebSocket
- MyBatis Plus 3.5.5
- MySQL Connector
- Redis
- MinIO 8.5.2
- JWT 0.11.5

## 📝 开发规范

### 代码规范
- 遵循Google Java代码风格
- 使用ESLint进行前端代码检查
- 遵循微信小程序开发规范

### Git规范
- 使用Git Flow分支管理
- 提交信息使用中文
- 重要功能创建独立分支

## 🤝 贡献指南

欢迎提交Issue和Pull Request。

1. Fork本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启Pull Request

## 📄 许可证

本项目仅供学习交流使用。

## ✅ 上线前检查

发布前请按 **[PRE_LAUNCH_CHECKLIST.md](./PRE_LAUNCH_CHECKLIST.md)** 逐项确认环境、功能、接口与体验。

## 📞 联系方式

如有问题，请提交 Issue。

---

**项目版本**: 1.0
**最后更新**: 2026-02-08
**维护者**: Farkle项目团队