diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index 67bad56970c31c8a588c938a4c4e9f0c887a34a0..0000000000000000000000000000000000000000
Binary files a/.DS_Store and /dev/null differ
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..496ee2ca6a2f08396a4076fe43dedf3dc0da8b6d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
\ No newline at end of file
diff --git a/.nojekyll b/.nojekyll
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/_config.yml b/_config.yml
new file mode 100644
index 0000000000000000000000000000000000000000..e616b9ae5542bcae9a226c43f238d520a21753b7
--- /dev/null
+++ b/_config.yml
@@ -0,0 +1 @@
+include: ['_coverpage.md', '_sidebar.md', '_navbar.md']
\ No newline at end of file
diff --git a/_coverpage.md b/_coverpage.md
index 37be3b3e0f9b41fc8216ef136e45c741908d18d9..4c4067113a3348f634208835895a65491903b018 100644
--- a/_coverpage.md
+++ b/_coverpage.md
@@ -1,6 +1,6 @@
-# [ApiAdmin 3.0.6](/README)
+# [ApiAdmin 3.0.6](zh-cn/3.0/readme.md)
> 基于ThinkPHP和Vue的接口开发管理系统
@@ -10,4 +10,4 @@
[GitHub](https://github.com/Zhao-github/ApiAdmin)
[Gitee](https://gitee.com/apiadmin/ApiAdmin)
-[马上开始](/README)
\ No newline at end of file
+[马上开始](zh-cn/3.0/readme.md)
\ No newline at end of file
diff --git a/_navbar.md b/_navbar.md
index b8a0279e3de997ffdf7c9fbdb9b1b1f24eb92a69..143a5fa13e43ab2a38a8d2fecf033e2e89a5b991 100644
--- a/_navbar.md
+++ b/_navbar.md
@@ -1,3 +1,3 @@
-- Documentation
+- 切换语言
- [简体中文](zh-cn/3.0/readme.md)
- [English](en-us/3.0/readme.md)
\ No newline at end of file
diff --git a/_sidebar.md b/_sidebar.md
index 3f5220a8368a540f010bbc74cdf4c83c79d99b8d..6656c7d48b4b266eab2516450087a32e6ca20f22 100644
--- a/_sidebar.md
+++ b/_sidebar.md
@@ -4,10 +4,10 @@
* 项目体验
- * [快速安装](quick-start.md)
- * [第一个API](first-api.md)
+ * [快速安装](zh-cn/3.0/quick-start.md)
+ * [第一个API](zh-cn/3.0/first-api.md)
-* 项目入门
+* [项目入门](zh-cn/3.0/readme.md)
* [名词解释]()
* [目录结构]()
diff --git a/en-us/3.0/readme.md b/en-us/3.0/readme.md
index ef4b3e12442a9628ef3d4009e096253dba96d160..e32ecf27954e6b61c213e8a4736ea5fb2f4ef65e 100644
--- a/en-us/3.0/readme.md
+++ b/en-us/3.0/readme.md
@@ -1 +1,101 @@
-test 3.0
\ No newline at end of file
+
:rocket: 基于ThinkPHP和Vue的接口开发管理系统
+ + + +> 站在巨人的肩膀上,并不是高的表现,反而使自己变得渺小~只有吸收了巨人的营养,茁壮自己才是真正的高大! --笔者 + +ApiAdmin从3.0开始,更加专注于API,将原先的MVC的架构转变为MVVM的方式,从管理系统本身出发彻底转变为纯API项目。所以ApiAdmin3.0是一个前后分离的项目,当前只针对PHP(后端) +部分,前端(Vue)部分是一个完全独立的全新项目,请移步 [ApiAdmin-WEB](https://gitee.com/apiadmin/ApiAdmin-WEB) + +### 项目介绍 + +**ApiAdmin**是一个专注于Api管理的项目,但是随着时间的发展,**ApiAdmin**将不仅仅关注于接口管理,**ApiAdmin**借着TP5的东风(为API开发而设计的高性能框架),在API开发方面做了很多的设想,同时也确实实现了部分功能,加速了API的开发。值的一提的是,**ApiAdmin**虽然是个框架,但是逐渐的具备了产品的特性(PS:框架本身就是一个产品),但是**ApiAdmin**并没有产品经理,所以功能细节可能不是太完善,但是绝对都是开发者迫切需要的功能 + +!> 希望有人用它,希望更多的人用它。希望它能帮助到你,希望它能帮助到更多的你。 + +**在线体验** +1. 项目地址:[https://admin.apiadmin.org](https://admin.apiadmin.org) +2. 账号获取:可以使用QQ一键登录[微信暂未开放],也可以加入QQ群获取 + +**系统需求** + +- PHP >= 5.6 +- MySQL >= 5.5.3 +- Redis + +**开源框架** + +- ThinkPHP v5.0.16 +- semanticUI +- php-curl-class + +**功能简介** + + 1. 接口文档自动生成 + 2. 接口输入参数自动检查 + 3. 接口输出参数数据类型自动规整 + 4. 灵活的参数规则设定 + 5. 采用AOP编程的思想,实现行为热拔插 + 6. 本地二次开发友好 + 7. 完全的API输出 + 8. ... + +```bash +ApiAdmin(PHP部分) +├─ 系统维护 +| ├─ 菜单管理 - 编辑访客权限,处理菜单父子关系,被权限系统依赖(极为重要) +| ├─ 用户管理 - 添加新用户,封号,删号以及给账号分配权限组 +| ├─ 权限管理 - 权限组管理,给权限组添加权限,将用户提出权限组 +| └─ 操作日志 - 记录管理员的操作,用于追责,回溯和备案 +| ... +``` + +**页面截图** + +
+
+
+
+
+
+
+
+
+
+
+
+**项目特性**
+
+- 开放源码
+- 保持生机
+- 不断更新
+- 响应市场
+
+**联系我们**
+- ApiAdmin技术交流群:221522638
+- ApiAdmin日常交流群:707621571
+
+**开源,我们在路上!**
+
+### 鸣谢
+
+- 感谢 [#开源中国#](https://www.oschina.net/) [#码云#](https://gitee.com/)
+- 感谢一路走来支持ApiAdmin的朋友们
+- 感谢在群里帮助过别人的朋友们
+- 感谢给ApiAdmin捐赠的朋友们
+- 感谢全体ApiAdmin工作开发人员
\ No newline at end of file
diff --git a/en-us/_sidebar.md b/en-us/_sidebar.md
index 00b93344245a5fd6d1ce6d22774b51891d9ddd3c..e80e6f1504902bd315ac37300c7b23064fb356aa 100644
--- a/en-us/_sidebar.md
+++ b/en-us/_sidebar.md
@@ -1,62 +1,44 @@
-* version log
+* Change Log
-* upgrade Guide
+* Upgrade Guide
-* project experience
+* Project Experience
- * [fast installation](en-us/3.0/quick-start.md)
- * [the first API](en-us/3.0/first-api.md)
+ * [Quick Start](en-us/3.0/quick-start.md)
+ * [Create First Demo](en-us/3.0/first-api.md)
-* project introduction
+* Get Started
- * [noun interpretation]()
+ * [Professional Terminology]()
+ * [Directory Structure]()
+ * [Flow Chart]()
+ * [Life Cycle]()
- * [directory structure]()
+* Features
- * [running process]()
+ * [System Configuration]()
+ * [Menu And User]()
+ * [Authority]()
+ * [Application]()
+ * [Interface]()
- * [life cycle]()
+* Secondary Development (PHP)
-* functional combing
+ * [Api Configuration]()
+ * [Application Authority]()
+ * [Cache]()
+ * [Api Router]()
+ * [Admin Router]()
+ * [Encryption Authentication]()
+ * [Security Recommendations]()
- * [system configuration]()
+* Secondary Development (Vue)
- * [menu user]()
+ * [Create Page]()
+ * [Menu Control]()
+ * [Browser Storage]()
+ * [Networking]()
+ * [Cross Domain]()
+ * [Vue Router]()
- * [system authority]()
-
- * [application management]()
-
- * [interface management]()
-
-* two opening details (PHP part)
-
- * [interface configuration]()
-
- * [application authority]()
-
- * [cache support]()
-
- * [interface routing]()
-
- * [backstage routing]()
-
- * [encryption authentication]()
-
- * [security recommendations]()
-
-* two opening details (Vue part)
-
- * [add a page]()
-
- * [menu permission control]()
-
- * [local storage instructions]()
-
- * [network request]()
-
- * [cross domain treatment]()
-
- * [VUE routing]()
-
-* FAQ
\ No newline at end of file
+* FAQ
diff --git a/index.html b/index.html
index c79869fe7ed81235a24aa7c6343c4d1f6e49f913..4c4865b29e20572acb332cdf06c2a918e9601bd9 100644
--- a/index.html
+++ b/index.html
@@ -15,8 +15,8 @@
diff --git a/zh-cn/3.0/quick-start.md b/zh-cn/3.0/quick-start.md
index b975de0a12d47c2113609bf82905bf2ec01c482c..339c5c55b4e43509a05b42211782b7929149f5d2 100644
--- a/zh-cn/3.0/quick-start.md
+++ b/zh-cn/3.0/quick-start.md
@@ -1,5 +1,143 @@
# 快速开始
# ApiAdmin
+在开始之前,请先确保如下环境已经成功安装.
+
+使用phpinfo()函数查看PHP的版本信息
+1. PHP >= 5.6
+2. MySQL >= 5.5.3
+3. Redis
+4. [composer](https://getcomposer.org) 或 [中国全量镜像](https://pkg.phpcomposer.com)
+
+首先获取代码
+[下载资源包](https://gitee.com/apiadmin/ApiAdmin/releases)
+通过[Git仓库](https://gitee.com/apiadmin/ApiAdmin/) 克隆
+如没有安装[Git](https://git-scm.com/downloads)请下载安装.
+```shell
+$ git clone https://gitee.com/apiadmin/ApiAdmin.git
+```
+
+使用composer安装
+```shell
+$ composer xxxxx
+```
+获取代码后上传到服务器
+导入SQL到Mysql:
+
+```path
+ ApiAdmin / data / apiadmin_3.0.6.sql
+```
+
+修改数据库配置文件:
+
+```path
+ ApiAdmin / application / database.php
+```
+
+```php
+ 'hostname' => '127.0.0.1', //修改成您MYSQL的实际地址
+ // 数据库名
+ 'database' => 'apiadmin', //导入SQL时的库名
+ // 用户名
+ 'username' => 'root', // 具有您所配置数据库所有权的用户名,不推荐使用root账号
+ // 密码
+ 'password' => '123456', // 密码
+```
+使用composer安装所需扩展
+```shell
+$ composer install
+```
+
+打开您的地址如看到以下信息,👍恭喜你成功的安装了 ApiAdmin🎉🎉🎉
+
+```
+{
+ "code": 1,
+ "msg": "操作成功",
+ "data": {
+ "Product": "NwTownApi",
+ "Version": "v3.0",
+ "Company": "ApiAdmin开发维护团队",
+ "ToYou": "I'm glad to meet you(终于等到你!)"
+ },
+ "debug": [
+ {
+ "TpVersion": "5.0.16"
+ }
+ ]
+}
+```
+
+# ApiAdmin-WEB
+
+配置可视化后台部份需要了解vue,webpack,npm的基本知识,当然你可以和我一起来搭建它。
+
+1.[node.js](https://nodejs.org/) 下载LTS版本 并安装
+
+在命令行检查node版本 npm 版本
+```shell
+$ node --version
+v8.1.2
+```
+```shell
+$ npm -v
+5.8.0
+```
+获取代码:
+[下载资源包](https://gitee.com/apiadmin/ApiAdmin-WEB/releases)
+通过[Git仓库](https://gitee.com/apiadmin/ApiAdmin-WEB)克隆
+如没有安装[Git](https://git-scm.com/downloads)请下载安装.
+```shell
+$ git clone https://gitee.com/apiadmin/ApiAdmin-WEB.git
+```
+```shell
+$ cd ApiAdmin-WEB
+```
+npm初始化项目所需:
+```shell
+$ npm install
+```
+好了,从零到有就这么几个命令..现在我们体验一下Apiadmin可视化后台.
+接下来有几个常用命令你一定要记牢:
+本地运行:
+```shell
+$ npm run dev
+```
+你可以通过 http://localhost:8180 来访问Apiadmin-web
+
+如需要上传到线上,还需要配置两处就可以了.
+
+/build/webpack.prod.config.js中的publicPath参数需要变更为你自己的项目域名
+```js
+let config = {
+ env: 'development',
+ baseUrl: 'https://api.apiadmin.org/admin/' // https://api.apiadmin.org更改为您项目的PHP后端域名
+};
+export default config;
+```
+/build/config.js中的baseUrl需要换成你自己搭建的后台接口域名
+
+```js
+module.exports = merge(webpackBaseConfig, {
+ output: {
+ publicPath: 'https://admin.apiadmin.org/dist/', // 修改 https://admin.apiadmin.org 这部分为你的静态部署服务器所配置的域名 与PHP后端非同一域名
+ filename: '[name].[hash].js',
+ chunkFilename: '[name].[hash].chunk.js'
+ },
+```
+编译VUE项目
+```shell
+$ npm run build
+```
+执行命令后我们回到项目目录内可以看到 dist目录下多出来一个dist目录,index.html文件
+```
+www/wwwroot/Apiadmin-web/dist/
+
+dist
+index.html
+```
+我们把dist目录,index.html文件上传到静态部署服务器就可以在线上看到您的可视化后台了.
+
+
+
-# ApiAdmin-WEB
\ No newline at end of file
diff --git a/zh-cn/3.0/readme.md b/zh-cn/3.0/readme.md
index 03155bca7ac8866db0dff78b235d603e99f29753..747d7015e130a14db34ade6e69374ead34ea074e 100644
--- a/zh-cn/3.0/readme.md
+++ b/zh-cn/3.0/readme.md
@@ -1 +1,101 @@
-测试 3.0
\ No newline at end of file
+:rocket: 基于ThinkPHP和Vue的接口开发管理系统
+ + + +> 站在巨人的肩膀上,并不是高的表现,反而使自己变得渺小~只有吸收了巨人的营养,茁壮自己才是真正的高大! --笔者 + +ApiAdmin从3.0开始,更加专注于API,将原先的MVC的架构转变为MVVM的方式,从管理系统本身出发彻底转变为纯API项目。所以ApiAdmin3.0是一个前后分离的项目,当前只针对PHP(后端) +部分,前端(Vue)部分是一个完全独立的全新项目,请移步 [ApiAdmin-WEB](https://gitee.com/apiadmin/ApiAdmin-WEB) + +## 项目介绍 + +**ApiAdmin**是一个专注于Api管理的项目,但是随着时间的发展,**ApiAdmin**将不仅仅关注于接口管理,**ApiAdmin**借着TP5的东风(为API开发而设计的高性能框架),在API开发方面做了很多的设想,同时也确实实现了部分功能,加速了API的开发。值的一提的是,**ApiAdmin**虽然是个框架,但是逐渐的具备了产品的特性(PS:框架本身就是一个产品),但是**ApiAdmin**并没有产品经理,所以功能细节可能不是太完善,但是绝对都是开发者迫切需要的功能 + +!> 希望有人用它,希望更多的人用它。希望它能帮助到你,希望它能帮助到更多的你。 + +**在线体验** +1. 项目地址:[https://admin.apiadmin.org](https://admin.apiadmin.org) +2. 账号获取:可以使用QQ一键登录[微信暂未开放],也可以加入QQ群获取 + +**系统需求** + +- PHP >= 5.6 +- MySQL >= 5.5.3 +- Redis + +**开源框架** + +- ThinkPHP v5.0.16 +- semanticUI +- php-curl-class + +**功能简介** + + 1. 接口文档自动生成 + 2. 接口输入参数自动检查 + 3. 接口输出参数数据类型自动规整 + 4. 灵活的参数规则设定 + 5. 采用AOP编程的思想,实现行为热拔插 + 6. 本地二次开发友好 + 7. 完全的API输出 + 8. ... + +```bash +ApiAdmin(PHP部分) +├─ 系统维护 +| ├─ 菜单管理 - 编辑访客权限,处理菜单父子关系,被权限系统依赖(极为重要) +| ├─ 用户管理 - 添加新用户,封号,删号以及给账号分配权限组 +| ├─ 权限管理 - 权限组管理,给权限组添加权限,将用户提出权限组 +| └─ 操作日志 - 记录管理员的操作,用于追责,回溯和备案 +| ... +``` + +**页面截图** + +
+
+
+
+
+
+
+
+
+
+
+
+**项目特性**
+
+- 开放源码
+- 保持生机
+- 不断更新
+- 响应市场
+
+**联系我们**
+- ApiAdmin技术交流群:221522638
+- ApiAdmin日常交流群:707621571
+
+**开源,我们在路上!**
+
+## 鸣谢
+
+- 感谢 [#开源中国#](https://www.oschina.net/) [#码云#](https://gitee.com/)
+- 感谢一路走来支持ApiAdmin的朋友们
+- 感谢在群里帮助过别人的朋友们
+- 感谢给ApiAdmin捐赠的朋友们
+- 感谢全体ApiAdmin工作开发人员
\ No newline at end of file
diff --git a/zh-cn/_sidebar.md b/zh-cn/_sidebar.md
index b6273b50986cb64901fc030d9f72dd8525cb8848..6656c7d48b4b266eab2516450087a32e6ca20f22 100644
--- a/zh-cn/_sidebar.md
+++ b/zh-cn/_sidebar.md
@@ -7,7 +7,7 @@
* [快速安装](zh-cn/3.0/quick-start.md)
* [第一个API](zh-cn/3.0/first-api.md)
-* 项目入门
+* [项目入门](zh-cn/3.0/readme.md)
* [名词解释]()
* [目录结构]()