# shorthand

**Repository Path**: practical-code/shorthand

## Basic Information

- **Project Name**: shorthand
- **Description**: shorthand 单词项目
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2026-03-05
- **Last Updated**: 2026-03-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Shorthand Cloud

简写云是一个基于 Spring Cloud 微服务架构的在线学习平台，提供课程内容管理、用户学习记录、支付等功能。

## 项目简介

Shorthand Cloud 是一个功能完善的在线教育平台后端服务，采用微服务架构设计。系统包含内容管理、用户前端、系统管理、支付中心等多个业务模块，支持中英文课程内容、练习题生成、学习记录追踪、订单支付等功能。

## 技术栈

- **后端框架**: Spring Boot 2.x + Spring Cloud
- **服务注册与配置**: Nacos
- **数据库**: MySQL + MyBatis Plus
- **缓存**: Redis
- **服务调用**: Feign + OpenFeign
- **安全**: Spring Security + JWT
- **分布式事务**: Seata
- **API文档**: SpringDoc (Swagger)
- **部署**: Docker + Docker Compose

## 系统架构

```
shorthand-gateway     # API网关
shorthand-auth        # 认证服务
shorthand-modules/
  ├── content        # 内容服务（课程、题库、学习记录）
  ├── front          # 前端用户服务
  ├── paycenter      # 支付中心
  └── system         # 系统管理（用户、角色、菜单、部门等）
shorthand-api/       # API接口定义
shorthand-common/    # 公共组件
```

## 核心功能

### 内容模块 (content)
- 中英文课程内容管理
- 课程单元管理
- 练习题生成与管理
- 学习记录追踪
- 内容搜索
- 收藏与反馈

### 前端模块 (front)
- 前端用户注册登录（手机号、邮箱）
- 验证码登录/注册
- 用户信息管理
- 登录日志记录

### 支付模块 (paycenter)
- 订单创建与管理
- 奇享支付集成
- PayPal支付集成
- 佣金分成

### 系统模块 (system)
- 用户管理
- 角色管理
- 菜单管理
- 部门管理
- 岗位管理
- 字典管理
- 参数配置
- 通知公告
- 日志管理

## 快速开始

### 环境要求

- JDK 8+
- Maven 3.6+
- Docker & Docker Compose
- MySQL 5.7+
- Redis

### 编译打包

```bash
mvn clean package -DskipTests
```

### Docker 部署

#### Linux 环境

```bash
cd docker-linux
./deploy.sh
```

#### 其他环境

```bash
cd docker
./deploy.sh
```

### 依赖服务启动

预环境配置位于 `docker-linux/pre-env/` 或 `docker/pre-env/` 目录下：

```bash
cd docker-linux/pre-env
docker-compose up -d
```

这将启动以下服务：
- Nacos (服务注册与配置中心)
- Redis (缓存)
- MySQL (数据库)

## 服务端口

| 服务 | 端口 |
|------|------|
| Gateway | 8080 |
| Auth | 8081 |
| System | 8082 |
| Content | 8083 |
| Front | 8084 |
| Paycenter | 8085 |
| Nacos | 8848 |
| Redis | 6379 |

## 项目结构

```
shorthand-cloud/
├── docker/                  # Docker 部署配置
├── docker-linux/            # Linux Docker 部署配置
├── sql/                     # 数据库脚本
├── shorthand-api/           # API 接口定义
├── shorthand-auth/          # 认证服务
├── shorthand-common/        # 公共模块
│   ├── shorthand-common-core           # 核心工具类
│   ├── shorthand-common-datascope      # 数据权限
│   ├── shorthand-common-datasource     # 多数据源
│   ├── shorthand-common-log            # 日志
│   ├── shorthand-common-redis          # Redis
│   ├── shorthand-common-seata          # Seata
│   ├── shorthand-common-security        # 安全
│   ├── shorthand-common-sensitive      # 敏感词
│   └── shorthand-common-swagger        # Swagger
├── shorthand-gateway/       # 网关服务
└── shorthand-modules/       # 业务模块
    ├── shorthand-modules-content        # 内容模块
    ├── shorthand-modules-front          # 前端模块
    ├── shorthand-modules-paycenter      # 支付模块
    └── shorthand-modules-system         # 系统模块
```

## 配置说明

主要配置文件位于各模块的 `src/main/resources/` 目录下：

- `bootstrap.yml` - 引导配置（连接 Nacos）
- `application.properties` - 应用配置

### Nacos 配置

各服务需要在 Nacos 中配置对应的命名空间和配置集，主要配置项包括：
- 数据库连接信息
- Redis 连接信息
- 服务端口
- 日志级别等

## API 文档

服务启动后，可通过以下地址访问 API 文档：

```
http://localhost:8080/swagger-ui.html
```

## 许可证

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