快速上手

XYGo Admin 2025-02-20 1188 次阅读

从零开始搭建开发环境，5 分钟启动项目

快速上手

环境准备

在开始之前，请确保你的开发环境已安装以下工具：

工具	版本要求	说明
Go	>= 1.22	后端运行环境
Node.js	>= 18	前端运行环境
pnpm	>= 8	包管理器（推荐）
MySQL 或 PostgreSQL	MySQL >= 5.7 / PG >= 12	数据库
Redis	>= 6	缓存服务
Git	最新版	版本控制

获取代码

bash 复制代码

# 克隆仓库
git clone https://gitee.com/a751300685a/xygo-admin.git
cd xygoadmin

数据库配置

1. 创建数据库

sql 复制代码

-- MySQL
CREATE DATABASE xygoadmin DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;

-- PostgreSQL
CREATE DATABASE xygoadmin WITH ENCODING 'UTF8';

2. 导入建表脚本

根据你使用的数据库类型，执行对应的 SQL 文件：

bash 复制代码

# MySQL
mysql -u root -p xygoadmin < mysql_install.sql

# PostgreSQL
psql -U postgres -d xygoadmin -f pgsql_install.sql

3. PostgreSQL 专用用户授权（可选）

如果你使用 postgres 超级用户导入 pgsql_install.sql，但在配置文件中改成普通用户连接（例如 xygo），需要先给这个用户授权；否则后端启动、迁移或代码生成时可能会提示表、序列或 public schema 权限不足。

请用 postgres 或数据库 owner 执行下面的 SQL，把 xygoadmin 和 xygo 替换成你的数据库名和用户名：

sql 复制代码

GRANT CONNECT ON DATABASE xygoadmin TO xygo;
GRANT USAGE ON SCHEMA public TO xygo;
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO xygo;
GRANT USAGE, SELECT, UPDATE ON ALL SEQUENCES IN SCHEMA public TO xygo;

ALTER DEFAULT PRIVILEGES IN SCHEMA public
  GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO xygo;
ALTER DEFAULT PRIVILEGES IN SCHEMA public
  GRANT USAGE, SELECT, UPDATE ON SEQUENCES TO xygo;

授权后，配置文件可以使用普通用户连接，例如：

yaml 复制代码

link: "pgsql:xygo:你的密码@tcp(127.0.0.1:5432)/xygoadmin"

如果一直使用 postgres 用户连接，可以跳过本步骤。

4. 修改配置文件

编辑 server/manifest/config/config.yaml，配置数据库连接信息：

yaml 复制代码

database:
  default:
    link: "pgsql:postgres:123456@tcp(127.0.0.1:5432)/xygoadmin"
    # 或 MySQL:
    # link: "mysql:root:123456@tcp(127.0.0.1:3306)/xygoadmin"

启动后端

bash 复制代码

cd server

# 安装 GoFrame CLI（首次）
go install github.com/gogf/gf/cmd/gf/v2@latest

# 启动服务
gf run main.go

服务默认运行在 http://localhost:8000。

启动前端

bash 复制代码

cd web

# 安装依赖
pnpm install

# 启动开发服务器
pnpm dev

浏览器会自动打开 http://localhost:5173。

默认账号

角色	账号	密码
超级管理员	admin	123456

常用命令

bash 复制代码

# 生成 DAO 代码
gf gen dao

# 生成 Service 接口
gf gen service

# 前端构建
pnpm build

# 前端代码检查
pnpm lint

提示：如果遇到问题，请查看常见问题章节。