Quick Start

Install the CLI

Option 1: go install (recommended)

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

Option 2: Install script

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

Create a Project

Interactive mode

gocronx init

The wizard will ask for:

1. Project name
2. Go module path
3. Database type (SQLite / MySQL / PostgreSQL)
4. Whether to enable Redis

Quick mode (CI-friendly)

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

Run the Project

cd myproject
make setup   # Install Go + frontend dependencies
make dev     # Start backend (:8080) + frontend (:3000)

Open http://localhost:3000 → complete the onboard wizard → done!

What Happens at First Launch

1. The frontend detects the app is not initialized and redirects to /onboard
2. You fill in: project name, admin credentials, database config, Redis toggle
3. The backend writes config.yaml, creates database tables, and sets up the admin user
4. You're redirected to the login page — use the admin credentials you just created

Project Commands

Command	Description
make setup	Install all dependencies
make dev	Start dev server (hot reload)
make build	Production build (Go binary + Vue dist)
make clean	Remove build artifacts