# yiyan

**Repository Path**: fancy_youth/yiyan

## Basic Information

- **Project Name**: yiyan
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-16
- **Last Updated**: 2026-09-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 易研智云（X5 GroundStation）Sprint 1 脚手架

![CI](https://github.com/<组织>/<仓库>/actions/workflows/ci.yml/badge.svg)

> Sprint 1 目标：完成项目基础脚手架、开发环境、CI/CD 流水线搭建。

## 快速启动

确保已安装 Docker、Docker Compose 和 Make：

```bash
make up
```

`make up` 会基于 `deploy/docker-compose.yml` 构建 `src/server` 与 `src/web` 镜像，并后台启动 MySQL、Redis、后端服务与前端服务。  
如需启用独立的 Nginx 反向代理（默认不启动），可执行：

```bash
docker compose -f deploy/docker-compose.yml --profile nginx up -d
```

访问地址：

- 前端：http://localhost
- 后端 API：http://localhost:8080
- MySQL：localhost:3306（root / yiyan_root）
- Redis：localhost:6379

## 常用命令

| 命令 | 说明 |
|------|------|
| `make build-server` | 单独构建后端镜像 |
| `make build-web` | 单独构建前端镜像 |
| `make up` | 构建并启动全部服务 |
| `make down` | 停止并移除服务及数据卷 |
| `make test-server` | 运行后端单元测试 |
| `make test-web` | 安装依赖并运行前端构建（冒烟测试） |
| `make lint` | 运行前后端静态检查 |

## 目录说明

| 目录/文件 | 说明 |
|-----------|------|
| `src/server/` | Go 后端服务源码与 Dockerfile |
| `src/web/` | Vue 3 前端源码与 Dockerfile |
| `src/server/migrations/` | MySQL 初始化脚本（platform.sql、tenant.sql） |
| `deploy/` | 部署配置（docker-compose.yml、Nginx 配置文件等） |
| `scripts/` | 运维辅助脚本（如 `init-db.sh`） |
| `.github/workflows/ci.yml` | GitHub Actions CI 流水线 |
| `Makefile` | 常用构建与运维命令 |

## CI 状态

- 触发方式：
  - `push` 到 `feature/sprint-01-scaffold` 分支
  - `pull_request` 到 `master` 分支
- 后端任务：Go 1.22，执行 `go mod tidy` 与 `go test ./...`
- 前端任务：Node.js 20，执行 `npm install` 与 `npm run build`

> 请将 CI badge 链接中的 `<组织>/<仓库>` 替换为实际 GitHub 仓库路径。

## 数据库初始化

MySQL 首次启动时会自动执行 `src/server/migrations/` 目录下的 SQL 脚本。  
如需手动重新执行，可运行：

```bash
./scripts/init-db.sh
```