跳转至正文

快速开始 ​

使用 dawn-simple 创建应用,系统管理、聊天和开发工具随项目启动。

环境 ​

  • Go 1.26+
  • Node.js 20.19+(20.x)或 22.12+,pnpm
  • Redis
  • MySQL、MariaDB、PostgreSQL 或 SQLite

默认使用 MariaDB。连接选项见配置。

获取项目 ​

sh
git clone https://github.com/dawnim/dawn-simple.git
cd dawn-simple
go mod download
pnpm --dir admin install --frozen-lockfile
cp .env.example .env

main 使用已发布的框架依赖;参与框架开发时使用 dev,见框架联调。

从基础应用独立接入框架,见创建空白项目。

配置连接 ​

先创建应用数据库,在 .env 填写连接:

dotenv
DB_CONNECTION=mariadb
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=dawn-admin
DB_USERNAME=your_user
DB_PASSWORD=your_password
REDIS_URL=redis://127.0.0.1:6379/0

生成应用密钥:

sh
go run . key:generate

命令自动生成密钥并写入 .env 的 APP_KEY。同一应用的多个实例使用相同密钥。

初始化与启动 ​

sh
go run . dawn:install
go run . dawn:start local

安装命令执行数据库迁移、基础数据填充和 IP 地理库准备。重复安装保留已有账号与配置。

打开 http://127.0.0.1:5173。首次账号为 admin / 123456,可在初始化前通过 DAWN_ADMIN_USERNAME、DAWN_ADMIN_PASSWORD 设置。首次登录后修改密码。

服务默认地址
前端http://127.0.0.1:5173
后台 APIhttp://127.0.0.1:5123/admin
WebSocketws://127.0.0.1:8851/

浏览器经 Vite 代理访问 API 与 WebSocket。前端支持热更新;修改 Go 后自动编译并更新服务;也可在新终端再次运行 go run . dawn:start local,接管日志与 Ctrl+C 控制。

开始开发 ​

后台管理业务接口放在 app/admin,页面放在 admin/src。先阅读架构与目录,再按后端开发和前端开发添加功能。

创建自己的项目时,修改 go.mod 模块名、源码导入、config/dawn.go 中的 module 和前端包名。框架能力通过 Go Module 与 npm 包升级。部署方式见服务运行。