Skip to content

Commit f643abd

Browse files
committed
README.md新增docker-compose的使用文档
1 parent 8ae25dc commit f643abd

File tree

2 files changed

+71
-0
lines changed

2 files changed

+71
-0
lines changed

README-zh_CN.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,41 @@ Gin-vue-admin 的成长离不开大家的支持,如果你愿意为 gin-vue-adm
6969

7070
## 2. 使用说明
7171

72+
> 使用docker-compose体验本项目
73+
- 安装 docker-compose [官方文档](https://docs.docker.com/compose/install/)
74+
- ```shell script
75+
# 在Linux安装
76+
# 1.1 运行此命令以下载Docker Compose的当前稳定版本
77+
sudo curl -L "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
78+
# 1.2 将可执行权限应用于二进制文件
79+
sudo chmod +x /usr/local/bin/docker-compose
80+
```
81+
- ```shell script
82+
# 使用Python的pip安装
83+
pip3 install docker-compose -i https://pypi.tuna.tsinghua.edu.cn/simple
84+
```
85+
- 使用 Docker Desktop
86+
- Windows: https://hub.docker.com/editions/community/docker-ce-desktop-windows
87+
- Mac: https://hub.docker.com/editions/community/docker-ce-desktop-mac/
88+
89+
- 使用git克隆本项目
90+
- ```git
91+
git clone https://github.com/flipped-aurora/gin-vue-admin.git
92+
```
93+
- 使用docker-compose up一键启动启动项目
94+
- ```shell script
95+
# 使用docker-compose启动四个容器
96+
docker-compose up
97+
# 如果您修改了某些配置选项,可以使用此命令重新打包镜像
98+
docker-compose up --build
99+
# 使用docker-compose 后台启动
100+
docker-compose up -d
101+
```
102+
103+
- web项目预览 [http://127.0.0.1:8888/admin](http://127.0.0.1:8888/admin)
104+
105+
- swagger文档 [http://127.0.0.1:8888/swagger/index.html](http://127.0.0.1:8888/swagger/index.html)
106+
72107
```
73108
- node版本 > v8.6.0
74109
- golang版本 >= v1.11

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,42 @@ We are excited that you are interested in contributing to gin-vue-admin. Before
7171

7272

7373
## 2. Getting started
74+
75+
> Use docker-compose to experience this project
76+
- Installation docker-compose [Official document](https://docs.docker.com/compose/install/)
77+
- ```shell script
78+
# Install on Linux
79+
# 1.1 Run this command to download the current stable version of Docker Compose
80+
sudo curl -L "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
81+
# 1.2 Apply executable permissions to binary files
82+
sudo chmod +x /usr/local/bin/docker-compose
83+
```
84+
- ```shell script
85+
# Use Python's pip installation
86+
pip3 install docker-compose -i https://pypi.tuna.tsinghua.edu.cn/simple
87+
```
88+
- Use Docker Desktop
89+
- Windows: https://hub.docker.com/editions/community/docker-ce-desktop-windows
90+
- Mac: https://hub.docker.com/editions/community/docker-ce-desktop-mac/
91+
92+
- Use git to clone this project
93+
- ```git
94+
git clone https://github.com/flipped-aurora/gin-vue-admin.git
95+
```
96+
- Use docker-compose up to start the startup project with one click
97+
- ```shell script
98+
# Use docker-compose to start four containers
99+
docker-compose up
100+
# If you modify some configuration options, you can use this command to repackage the image
101+
docker-compose up --build
102+
# Use docker-compose to start in the background
103+
docker-compose up -d
104+
```
105+
106+
- Web project preview [http://127.0.0.1:8888/admin](http://127.0.0.1:8888/admin)
107+
108+
- swagger APIs [http://127.0.0.1:8888/swagger/index.html](http://127.0.0.1:8888/swagger/index.html)
109+
74110
```
75111
- node version > v8.6.0
76112
- golang version >= v1.11

0 commit comments

Comments
 (0)