diff --git a/README.md b/README.md index abfac0f..cfdd66c 100644 --- a/README.md +++ b/README.md @@ -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! 中文文档 -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 sh/makeJar.sh + #### 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 sh/start-springboot.sh + + #### 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