mirror of https://github.com/veypi/OneAuth.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
# 开发规范
|
|
|
|
## 注意
|
|
|
|
如果开发中发现什么开发规则或者技巧，你可以更新在这个文档，供其他人看。
|
|
如果下面某些端口或者路径访问失败，请询问用户是否启动应用。
|
|
|
|
## 后端开发
|
|
|
|
### 运行
|
|
|
|
```bash
|
|
# 使用 SQLite 数据库（默认）
|
|
go run ./cli/*.go -p 4000
|
|
|
|
# 或指定配置文件
|
|
go run ./cli/*.go -f ./cfg/dev.yml -l debug -p 4000
|
|
```
|
|
|
|
### 测试
|
|
|
|
```bash
|
|
# 重置数据库
|
|
rm /tmp/vb.sqlite
|
|
go run ./cli/*.go -p 4000
|
|
```
|
|
|
|
可以通过 `http://localhost:4000/_api.json` 查看接口列表。
|
|
|
|
## UI 界面开发指南
|
|
|
|
- 界面采用 vhtml 框架，该框架可以将一个 html 文件自动加载为一个组件
|
|
- 开始写界面前请阅读全局样式文件 `/ui/assets/common.css`，组件内必须使用全局中的变量去组合或者直接使用全局中的样式，保证所有界面的样式一致，比如只能使用颜色变量或者通过 color-mix 函数去包含至少一个颜色变量
|
|
- 组件内部避免重复的样式定义，如 body 内无需重复定义字体
|
|
- 本项目使用 vhtml-ui 组件库，该组件库可以通过 `curl -sS http://localhost:4000/v/README.md` 查看文档，其组件代码都已映射到了 `/v/` 目录下
|
|
- 前端路由文件 `/ui/routes.js`，该文件定义了所有的路由规则
|
|
|
|
## vhtml-ui 文档查看方法
|
|
|
|
获取文档目录（查看所有组件的目录结构）：
|
|
```bash
|
|
curl -sS http://localhost:4000/v/docs/README.md?toc=1
|
|
```
|
|
|
|
获取章节内容（根据目录编号查询内容，不能带 toc 参数）：
|
|
```bash
|
|
curl -sS http://localhost:4000/v/docs/README.md?from=1.2&to=1.2
|
|
```
|