Skip to content

quick-start.md

Latest commit

 

History

History
119 lines (81 loc) · 1.91 KB

quick-start.md

File metadata and controls

119 lines (81 loc) · 1.91 KB

快速开始

本指南将帮助你快速搭建和运行 yflow 项目。

环境要求

  • Go 1.23+
  • Node.js ^20.19.0 || >=22.12.0
  • pnpm
  • Rust (stable) + Cargo
  • MySQL 8.0+
  • Redis 7.0+

1. 克隆项目

git clone https://github.com/ishechuan/yflow.git
cd yflow

2. 配置数据库

确保 MySQL 和 Redis 已启动，并创建数据库：

CREATE DATABASE yflow DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

3. 配置环境变量

后端配置

cd admin-backend
cp .env.example .env

编辑 .env 文件：

# Database
DB_HOST=localhost
DB_PORT=3306
DB_USERNAME=root
DB_PASSWORD=your_password
DB_NAME=yflow

# Redis
REDIS_HOST=localhost
REDIS_PORT=6379

# JWT (至少 32 位，生产环境务必替换)
JWT_SECRET=your_jwt_secret_min_32_chars
JWT_REFRESH_SECRET=your_refresh_secret_min_32_chars

# CLI API Key（至少 16 位）
CLI_API_KEY=your_api_key_min_16_chars

ENV=development
GO_ENV=development

前端配置

前端无需额外配置，API 地址可在开发时修改。

4. 启动后端

cd admin-backend

# 安装依赖
go mod tidy

# 启动开发服务器（带热重载）
air

后端将在 http://localhost:8080 启动。

5. 启动前端

cd admin-frontend

# 安装依赖
pnpm install

# 启动开发服务器
pnpm dev

前端将在 http://localhost:5173 启动。

6. 首次访问

  1. 打开浏览器访问 http://localhost:5173
  2. 使用管理员账户登录（或联系系统管理员创建）
  3. 开始创建你的第一个项目！

7. 安装 CLI 工具

cd cli

# 编译 release
cargo build --release

# 或安装到本机（~/.cargo/bin/yflow）
# cargo install --path .

现在可以使用 yflow 命令了。

下一步