doc: 更新README.md和提问模板

Author: PedroGao

.github/ISSUE_TEMPLATE/question.md

@@ -1,5 +1,5 @@
 ---
-name: 问题
+name: 提出问题
 about: 关于项目的疑问
 ---
 

README.md

@@ -1,20 +1,47 @@
-# Lin-CMS-Flask
+<!-- # Lin-CMS-Flask -->
 
-## 什么是 Lin CMS？
+<h1 align="center">
+  <a href="http://doc.cms.7yue.pro/">
+  <img src="http://doc.cms.7yue.pro/left-logo.png" width="250"/></a>
+  <br>
+  Lin-CMS-Flask
+</h1>
+
+<h4 align="center">一个简单易用的CMS后端项目 | <a href="http://doc.cms.7yue.pro/" target="_blank">Lin-CMS-Flask</a></h4>
+
+<p align="center">
+  <a href="http://flask.pocoo.org/docs/1.0/" rel="nofollow">
+  <img src="https://img.shields.io/badge/flask-%3D%3D1.0.2-yellow.svg" alt="flask version" data-canonical-src="https://img.shields.io/badge/flask-%3D%3D1.0.2-yellow.svg" style="max-width:100%;"></a>
+  <a href="https://pypi.org/project/Lin-CMS/" rel="nofollow"><img src="https://img.shields.io/badge/lin--cms-%3D%3D0.1.1-orange.svg" alt="lin-cms version" data-canonical-src="https://img.shields.io/badge/lin--cms-%3D%3D0.1.1-orange.svge" style="max-width:100%;"></a>
+  <a href="http://doc.cms.7yue.pro/" rel="nofollow"><img src="https://img.shields.io/badge/license-MIT-lightgrey.svg" alt="LISENCE" data-canonical-src="https://img.shields.io/badge/license-MIT-lightgrey.svg" style="max-width:100%;"></a>
+</p>
+
+<blockquote align="center">
+  <em>Lin-CMS</em> 是林间有风团队经过大量项目实践所提炼出的一套<strong>内容管理系统框架</strong>。<br>
+ Lin-CMS 可以有效的帮助开发者提高 CMS 的开发效率。
+</blockquote>
+
+<p align="center">
+  <a href="#简介">简介</a>&nbsp;|&nbsp;<a href="#快速开始">快速开始</a>&nbsp;|&nbsp;<a href="#下个版本开发计划">下个版本开发计划</a>
+</p>
+
+## 简介
+
+### 什么是 Lin CMS？
 
 Lin-CMS 是林间有风团队经过大量项目实践所提炼出的一套**内容管理系统框架**。Lin-CMS 可以有效的帮助开发者提高 CMS 的开发效率。
 
 本项目是 Lin CMS 后端的 Flask 实现，访问[前端仓库](https://github.com/TaleLin/lin-cms-vue)。
 
-## 地址文档
+### 文档地址
 
 [http://doc.cms.7yue.pro/](http://doc.cms.7yue.pro/)
 
-## Lin CMS 的特点
+### Lin CMS 的特点
 
 Lin CMS 的构筑思想是有其自身特点的。下面我们阐述一些 Lin 的主要特点。
 
-### Lin CMS 是一个前后端分离的 CMS 解决方案
+#### Lin CMS 是一个前后端分离的 CMS 解决方案
 
 这意味着，Lin 既提供后台的支撑，也有一套对应的前端系统，当然双端分离的好处不仅仅在于此，我们会在后续提供`NodeJS`和`PHP`版本的 Lin。如果你心仪 Lin，却又因为技术栈的原因无法即可使用，没关系，我们会在后续提供更多的语言版本。为什么 Lin 要选择前后端分离的单页面架构呢？
 
@@ -25,39 +52,106 @@ Lin CMS 的构筑思想是有其自身特点的。下面我们阐述一些 Lin 
 
 其次，单页面应用程序的体验本身就要好于传统网站。
 
-### 框架本身已内置了 CMS 常用的功能
+#### 框架本身已内置了 CMS 常用的功能
 
 Lin 已经内置了 CMS 中最为常见的需求：用户管理、权限管理、日志系统等。开发者只需要集中精力开发自己的 CMS 业务即可
 
-### Lin CMS 本身也是一套开发规范
+#### Lin CMS 本身也是一套开发规范
 
 Lin CMS 除了内置常见的功能外，还提供了一套开发规范与工具类。换句话说，开发者无需再纠结如何验证参数？如何操作数据库？如何做全局的异常处理？API 的结构如何？前端结构应该如何组织？这些问题 Lin CMS 已经给出了解决方案。当然，如果你不喜欢 Lin 给出的架构，那么自己去实现自己的 CMS 架构也是可以的。但通常情况下，你确实无需再做出架构上的改动，Lin 可以满足绝大多数中小型的 CMS 需求。
 
 举例来说，每个 API 都需要校验客户端传递的参数。但校验的方法有很多种，不同的开发者会有不同的构筑方案。但 Lin 提供了一套验证机制，开发者无需再纠结如何校验参数，只需模仿 Lin 的校验方案去写自己的业务即可。
 
 还是基于这样的一个原则：Lin CMS 只需要开发者关注自己的业务开发，它已经内置了很多机制帮助开发者快速开发自己的业务。
 
-### 基于插件的扩展
+#### 基于插件的扩展
 
 任何优秀的框架都需要考虑到扩展。而 Lin 的扩展支持是通过插件的思想来设计的。当你需要新增一个功能时，你既可以直接在 Lin 的目录下编写代码，也可以将功能以插件的形式封装。比如，你开发了一个文章管理功能，你可以选择以插件的形式来发布，这样其他开发者通过安装你的插件就可以使用这个功能了。毫无疑问，以插件的形式封装功能将最大化代码的可复用性。你甚至可以把自己开发的插件发布，以提供给其他开发者使用。这种机制相当的棒。
 
-### 前端组件库支持
+#### 前端组件库支持
 
 Lin 还将提供一套类似于 Vue Element 的前端组件库，以方便前端开发者快速开发。相比于 Vue Element 或 iView 等成熟的组件库，Lin 所提供的组件库将针对 Lin CMS 的整体设计风格、交互体验等作出大量的优化，使用 Lin 的组件库将更容易开发出体验更好的 CMS 系统。当然，Lin 本身不限制开发者选用任何的组件库，你完全可以根据自己的喜好/习惯/熟悉度，去选择任意的一个基于 Vue 的组件库，比如前面提到的 Vue Element 和 iView 等。你甚至可以混搭使用。当然，前提是这些组件库是基于 Vue 的。
 
-### 完善的文档
+#### 完善的文档
 
 我们将提供详尽的文档来帮助开发者使用 Lin
 
-## 所需基础
+### 所需基础
 
 由于 Lin 采用的是前后端分离的架构，所以你至少需要熟悉 Python 和 Vue。
 
 Lin 的服务端框架是基于 Python Flask 的，所以如果你比较熟悉 Flask 的开发模式，那将可以更好的使用 Lin。但如果你并不熟悉 Flask，我们认为也没有太大的关系，因为 Lin 本身已经提供了一套完整的开发机制，你只需要在 Lin 的框架下用 Python 来编写自己的业务代码即可。照葫芦画瓢应该就是这种感觉。
 
 但前端不同，前端还是需要开发者比较熟悉 Vue 的。但我想以 Vue 在国内的普及程度，绝大多数的开发者是没有问题的。这也正是我们选择 Vue 作为前端框架的原因。如果你喜欢 React Or Angular，那么加入我们，为 Lin 开发一个对应的版本吧。
 
-## TODO LIST
+## 快速开始
+
+### Server 端必备环境
+
+- 安装`MySQL`（version： 5.6+）
+
+- 安装`Python`环境(version： 3.6+)
+
+### 获取工程项目
+
+打开你的命令行工具（terminal），在其中键入:
+
+```bash
+git clone https://github.com/TaleLin/lin-cms-flask.git starter
+```
+
+> 此处我们以 `starter` 作为工程名，当然你也可以以任意你喜爱的名字作为工程名。
+> 如果你想以某个版本，如`0.0.1`版，作为起始项目，那么请在 github 上的版本页下载相应> 的版本即可。
+
+### 安装依赖包
+
+我们强烈建议使用 Python 的虚拟环境来安装依赖包，推荐使用 Pipenv 来创建虚拟环境。关于`Pipenv`的更多使用请参考[Pipenv 官网](https://pipenv.readthedocs.io/en/latest/)。接下来，继续在命令行中输入：
+
+```bash
+cd starter && pipenv install --dev
+```
+
+执行此命令前，请确保系统中已成功安装了 pipenv。这将为 Lin 创建一个虚拟环境并安装所有依赖包。如果你不想使用虚拟环境，那么键入以下命令：
+
+```bash
+cd starter && pip install -r requirements.txt
+```
+
+这将调用系统环境中的 pip 来安装依赖包。
+
+### 数据库配置
+
+Lin 需要你自己在 MySQL 中新建一个数据库，名字由你自己决定。例如，新建一个名为 lin-cms 的数据库。接着，我们需要在工程中进行一项简单的配置。使用编辑器打开 Lin 工程的`app/config/secure.py`，找到如下配置项：
+
+```py
+# 数据库配置示例
+SQLALCHEMY_DATABASE_URI = 'mysql+cymysql://root:123456@localhost:3306/lin-cms'
+```
+
+请在`SQLALCHEMY_DATABASE_URI`这项中配置 MySQL 数据库的用户名、密码、ip、端口号与数据库名。**请务必根据自己的实际情况修改此配置项**。
+
+> 你所使用的数据库账号必须具有创建数据表的权限，否则 Lin 将无法为你自动创建数据表
+
+### 运行
+
+一切就绪后，再次从命令行中使用 Python 命令运行项目根目录下的`starter.py`：
+
+```bash
+python starter.py
+```
+
+如果你是以 pipenv 创建的虚拟环境，那么请先通过下面命令进入虚拟环境，再运行上面的命令。
+
+```bash
+pipenv shell
+```
+
+如果一切顺利，你将在命令行中看到项目成功运行的信息。如果你没有修改代码，Lin 将默认在本地启动一个端口号为 5000 的端口用来监听请求。此时，我们访问http://localhost:5000，将看到一组字符：
+
+“心上无垢，林间有风"
+
+这证明你已经成功的将 Lin 运行起来了，Congratulations！
+
+## 下个版本开发计划
 
-- [ ] 消息推送
-- [ ] Node 版 CMS
+- [ ] 添加消息推送机制