-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
39 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,39 @@ | ||
vmihub | ||
VMIhub | ||
==== | ||
![](https://github.com/projecteru2/vmihub/workflows/test/badge.svg) | ||
![](https://github.com/projecteru2/vmihub/workflows/golangci-lint/badge.svg) | ||
|
||
virtual machine image hub for ERU | ||
|
||
# swagger | ||
### Swagger | ||
generate swagger | ||
```shell | ||
make swag | ||
``` | ||
|
||
### Mac 下安装swagger | ||
#### Install swagger on MacOS | ||
https://github.com/swaggo/swag/blob/v1.16.1/README_zh-CN.md | ||
|
||
generate swagger | ||
Generate swagger | ||
```shell | ||
swag init -g cmd/vmihub/main.go -o cmd/vmihub/docs | ||
``` | ||
# 准备redis | ||
常规准备就好 | ||
|
||
# 准备数据库 | ||
不管是第一次初始化数据库还是后续数据库schema的修改请都参考 [这里](internal/models/migration/README.md) | ||
# 准备s3 | ||
用于存储镜像文件 | ||
### Redis | ||
Require Redis | ||
|
||
### DB | ||
[ReadME](internal/models/migration/README.md) | ||
|
||
# 编译 | ||
### S3 | ||
Local can use minio | ||
|
||
### Build | ||
```shell | ||
make | ||
``` | ||
|
||
# 项目启动 | ||
### Start | ||
```shell | ||
bin/vmihub --config=config/config.example.toml server | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters