跳到主要内容

本地开发

前置:Go 1.27+、Node 18+(仅 web 构建需要)。

启动开发环境​

git clone https://github.com/yunqilee69/OmniGate
cd OmniGate

./start.sh # 开发模式:后端 :27777 + Vite 热更新 :27778
./start.sh --prod # 生产模式:后端 + 内嵌前端 :27777

./start.sh 与用户实例完全隔离:

  • 数据库落在仓库内 data/
  • 端口固定为 27777 / 27778
  • 不读 ~/.omnigate
  • 开发模式管理台走 http://localhost:27778/manage

日志分别在 logs/backend.log 和 logs/frontend.log。Ctrl+C 会杀掉整个进程树。

操作开发实例:

./omnigate stop --db ./data/omnigate.db
./omnigate restart --db ./data/omnigate.db
./omnigate status --db ./data/omnigate.db

只编后端​

go build -o omnigate ./cmd/omnigate

只编前端​

产物落到 internal/webui/dist/,由 Go go:embed 嵌入:

cd web && npm ci && npm run build

internal/webui/dist/ 不要进特性 commit——它由 npm run build 重新生成。唯一例外是 .gitkeep,go:embed all:dist 不接受空目录。

测试​

go test ./...
go vet ./...
go test -race ./...

测试约定与提交前检查见 测试与质量。

文档​

docs/ 是文档站源目录。改完文档在本地同步到 cludix-doc 预览:

./scripts/sync-docs.sh --dry-run
./scripts/sync-docs.sh --build

侧边栏源文件在 publish/cludix-doc/sidebars/projects/omnigate.ts,新增/改名文档时要一起改。