Skip to content

快速开始

安装 CLI

方式一:go install(推荐)

bash
go install github.com/gocronx/gocronx-scaffold/cmd/gocronx@latest

方式二:安装脚本

bash
curl -fsSL https://raw.githubusercontent.com/gocronx/gocronx-scaffold/main/install.sh | bash

创建项目

交互式模式

bash
gocronx init

向导会依次询问:

  1. 项目名称
  2. Go module 路径
  3. 数据库类型(SQLite / MySQL / PostgreSQL)
  4. 是否启用 Redis

快速模式(适合 CI)

bash
gocronx init myproject --module github.com/yourname/myproject --db sqlite --redis

运行项目

bash
cd myproject
make setup   # 安装 Go 和前端依赖
make dev     # 启动后端 (:8080) + 前端 (:3000)

打开 http://localhost:3000 → 完成初始化向导 → 开始使用!

首次启动发生了什么

  1. 前端检测到系统未初始化,自动跳转到 /onboard 页面
  2. 填写:项目名称、管理员账号密码、数据库配置、Redis 开关
  3. 后端写入 config.yaml、创建数据表、创建管理员用户
  4. 跳转到登录页 — 使用刚才创建的管理员账号登录即可

项目命令

命令说明
make setup安装所有依赖
make dev启动开发服务器(热重载)
make build生产构建(Go 二进制 + Vue 产物)
make clean清理构建产物