开发者指南
感谢您对 Beszel 开发的兴趣!
我们欢迎您的贡献,如果您计划进行任何重大更改,最好先在讨论或问题中与我们联系。
先决条件
- Go 1.23+(用于修改 Go 代码)
- Bun 1.1.38+ 或 Node 18+(用于修改管理 UI)
如果您还没有,请 fork 仓库 并克隆您的 fork 到本地工作:
bash
git clone https://github.com/your_username/beszel.git
为不同的更改创建单独的分支
建议为每个错误修复和功能创建一个新的分支。 如果您计划提交多个 PR 以便在最终合并之前单独进行审查,则这是必需的。
开发环境
为了进行项目开发,需要启动三个进程:
- 中心 (Go)
- 代理程序 (Go)
- Web UI (TypeScript / Vite)
每个作业都有一个 make
命令启动(在 /beszel
目录中运行)。
bash
# 启动中心
make dev-hub
# 启动代理程序
KEY="..." make dev-agent
# 启动 Web UI
make dev-server
或者,您可以一次启动所有进程并结合输出:
bash
KEY="..." make -j dev
导航到 http://localhost:8090 查看 Web UI。
提示
如果安装了 entr
,则当您保存代码更改时,中心/代理程序会自动重建。