Skip to content

Commit

Permalink
docs:edit README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HCJ0001 committed Jul 30, 2021
1 parent 5793ebf commit c1bf6c9
Showing 1 changed file with 33 additions and 19 deletions.
52 changes: 33 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
A powerful All-in-one API management and testing platform, we devote to making APIs Management easier!
Vpi is a powerful All-in-one API management and testing platform, we devote to making APIs Management easier!
<a href="README_zh_CN.md">中文文档</a>

Use **sh/makeJar.sh**, set config to start!
## Config files:
front/.env.production
ams/src/main/java/press.whcj.ams.common.Constant.SysConfig
ams/src/main/resources/application-prod.yml
## Need install:
jdk1.8
chromePlugin,
mongodb(init/install-mongodb.sh)
nginx
```
if use sh/makeJar.sh,need install:git,maven,npm
```
# Getting Started
* The separation of front-end and backend
use <a href="sh/makeJar.sh">sh/makeJar.sh</a>
#### Config:
front/.env.production
ams/src/main/java/press.whcj.ams.common.Constant.SysConfig
ams/src/main/resources/application-prod.yml
#### Dependencies:
jdk1.8
chromePlugin(Optional)
mongodb(init/install-mongodb.sh)
nginx
maven
node

* Build an application with a monolithic architecture(put the html into jar after building)
use <a href="sh/start-springboot.sh">sh/start-springboot.sh</a>

#### Dependencies:
jdk1.8
chromePlugin(Optional)
mongodb(init/install-mongodb.sh)
maven(Optional)
node(Optional)
*Version v1.03+, run jar with your configuration of mongoDB*
```
# mongoDB configurations: conf/application-prod.yml
nohup java -jar ams.jar --spring.config.location=classpath:/application.yml,conf/application-prod.yml > vpi.log 2>&1 &
```
## Demo:
http://www.whcj.press
http://www.whcj.press
testAccount: lx/123456
## Help:
http://www.whcj.press/help



http://www.whcj.press/help

0 comments on commit c1bf6c9

Please sign in to comment.