README.md 9.1 KB
Newer Older
S
develop  
server 已提交
1

S
develop  
server 已提交
2 3
<p align="center">
  <a href="https://modstart.com">
ModStart's avatar
develop  
ModStart 已提交
4
    <img src="https://ms-assets.modstart.com/data/image/2021/09/08/23652_1f1j_9825.png" alt="ModStart" width="360" />
S
develop  
server 已提交
5 6 7
  </a>
</p>
<p align="center">
ModStart's avatar
develop  
ModStart 已提交
8
  模块化的极速开发框架
S
develop  
server 已提交
9 10 11 12
</p>

<p align="center">  
  <a href="https://github.com/modstart/ModStartCMS" target="_blank">
S
develop  
server 已提交
13
    <img alt="License Apache2.0" src="https://img.shields.io/badge/License-Apache2.0-blue">
S
develop  
server 已提交
14 15 16 17
  </a>
  <a href="https://github.com/modstart/ModStartCMS" target="_blank">
    <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/modstart/ModStartCMS">
  </a>
S
develop  
server 已提交
18 19 20
  <a href="https://github.com/modstart/ModStartCMS" target="_blank">
    <img alt="GitHub last release" src="https://img.shields.io/github/v/release/modstart/ModStartCMS">
  </a>
S
develop  
server 已提交
21 22 23 24 25 26 27 28 29 30
  <br />
  <a href="https://github.com/modstart/ModStartCMS" target="_blank">
    <img alt="Laravel" src="https://img.shields.io/badge/Framework-ModStart-blue">
  </a>
  <a href="https://github.com/modstart/ModStartCMS" target="_blank">
    <img alt="Laravel" src="https://img.shields.io/badge/PHP-Laravel-red">
  </a>
  <a href="https://github.com/modstart/ModStartCMS" target="_blank">
    <img alt="Laravel" src="https://img.shields.io/badge/JS-Vue-green">
  </a>
S
develop  
server 已提交
31 32 33
</p>


ModStart's avatar
develop  
ModStart 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
# ModStart是基于Laravel的模块化极速开发框架


##  🔥 功能一览

最新版本 <img alt="GitHub last release" style="vertical-align:middle;height:18px;" src="https://img.shields.io/github/v/release/modstart/ModStartCMS?style=flat-square">,功能完善,模块市场丰富,欢迎交流。QQ交流群: [467107293](https://qm.qq.com/cgi-bin/qm/qr?k=JP5GySRSCM8BUVoIGwfXF_bCe6gPajEb&jump_from=webapi)

- 会员模块通用且完整,支持完整的API调用
- 大文件分片上传,进度条显示,已上传文件管理
- 强大的模块扩展功能,所有模块可以无缝集成,支持在线安装、卸载模块
- 完善的开发助手,实现模块、主题的的一键创建
- 完善的后台权限管理,支持基于RBAC的权限管理系统
- 后台管理自使用手机、平板、PC,无论何时何地都可方便管理
- 第三方登录(QQ、微信、微博)
- 第三方支付支持(微信、支付宝),微信支持PC端扫码支付
- 第三方云存储支持,支持云储存分片上传(阿里云、百度云、华为云、腾讯云、FTP、七牛云、UCloud、又拍云)
- 第三方短信支持(阿里云、腾讯云、华为云、百度云、253云通讯、聚合、七牛云、融云、赛邮、UCloud、云片、网易云)
- 丰富优秀的模块支持:
  - [视频点播课](https://modstart.com/m/CourseVideo)
  - [一物一码防伪溯源](https://modstart.com/m/Tracking)
  - [文章投稿系统](https://modstart.com/m/CmsWriter)
  - [Markdown文档管理](https://modstart.com/m/Markdown)
  - [视频管理系统](https://modstart.com/m/Video)
  - [邮件营销系统](https://modstart.com/m/Edm)
  - [视频直播系统](https://modstart.com/m/CourseLive)
  - [文库系统](https://modstart.com/m/Wenku)
  - [相册系统](https://modstart.com/m/Photo)
  - [文库系统](https://modstart.com/m/Wenku)
  - [问答系统](https://modstart.com/m/Wenda)
  - [IT工具箱](https://modstart.com/m/Tools)
  - [帮助中心系统](https://modstart.com/m/CmsHelp)
  - [短连接系统](https://modstart.com/m/ShortLink)
  - [论坛系统](https://modstart.com/m/Forum)
  - [个人博客系统](https://modstart.com/m/Blog)
  - [发卡系统](https://modstart.com/m/Faka)
  - [积分商城](https://modstart.com/m/CreditShop)
  - [兼职招聘系统](https://modstart.com/m/Hire)
  - [课程报名系统](https://modstart.com/m/Course)
  - [活动报名系统](https://modstart.com/m/Event)
  - [简单商城系统](https://modstart.com/m/Shop)
  - [网盘系统](https://modstart.com/m/Pan)
  - [微信公众号管理系统](https://modstart.com/m/WechatMP)
  - [在线客服系统](https://modstart.com/m/LiveChat)
S
develop  
server 已提交
77

ModStart's avatar
develop  
ModStart 已提交
78
##  💡 系统简介
S
develop  
server 已提交
79

ModStart's avatar
develop  
ModStart 已提交
80
`ModStart` 是一个基于 `Laravel` 模块化极速开发框架。模块市场拥有丰富的功能应用,支持后台一键快速安装,让开发者能快的实现业务功能开发。 
S
develop  
server 已提交
81

ModStart's avatar
develop  
ModStart 已提交
82
系统完全开源,基于 Apache 2.0 开源协议,**免费且不限制商业使用**
S
develop  
server 已提交
83

S
develop  
server 已提交
84

S
develop  
server 已提交
85
<img src="https://ms-assets.modstart.com/data/image/2021/11/07/46017_dv5r_7358.jpg" alt="功能架构" />
S
develop  
server 已提交
86 87

- [官方网站](https://modstart.com)
ModStart's avatar
develop  
ModStart 已提交
88
- [在线演示](https://cms.demo.tecmz.com)
S
develop  
server 已提交
89
- [模块市场](https://modstart.com/store)
ModStart's avatar
develop  
ModStart 已提交
90
- [源码地址 / Gitee](https://gitee.com/modstart/ModStartCMS)
S
develop  
server 已提交
91 92
- [源码地址 / GitHub](https://github.com/modstart/ModStartCMS)

S
develop  
server 已提交
93
**技术栈**
S
develop  
server 已提交
94 95 96 97

- [Laravel](https://laravel.com/)
- [Vue](https://vuejs.org/)
- [Element UI](https://element.eleme.io/)
S
develop  
server 已提交
98
- [LayUI](https://github.com/sentsin/layui)
ModStart's avatar
develop  
ModStart 已提交
99
- [jQuery](http://jquery.com)
S
develop  
server 已提交
100

S
develop  
server 已提交
101 102

##  💥 系统特性
S
develop  
server 已提交
103 104 105

- 简洁优雅、灵活可扩展
- 后台RBAC权限管理
ModStart's avatar
develop  
ModStart 已提交
106
- 模块化开发,积木式搭建系统
S
develop  
server 已提交
107
- 组件按需加载静态资源
ModStart's avatar
develop  
ModStart 已提交
108
- 丰富的数据表格、数据表单功能
S
develop  
server 已提交
109
- 内置文件上传,无需繁琐的开发
ModStart's avatar
develop  
ModStart 已提交
110
- 丰富的模块市场,后台一键快速安装
S
develop  
server 已提交
111 112 113



S
develop  
server 已提交
114 115 116 117 118 119
## 🎨 系统演示

### 前台演示地址

[http://cms.demo.tecmz.com/](http://cms.demo.tecmz.com/)

ModStart's avatar
develop  
ModStart 已提交
120
> 用户密码自行注册使用
S
develop  
server 已提交
121

S
develop  
server 已提交
122 123 124 125
### 后台演示地址

[http://cms.demo.tecmz.com/admin](http://cms.demo.tecmz.com/admin)

ModStart's avatar
develop  
ModStart 已提交
126 127 128 129 130 131 132 133 134 135
> 账号:`demo` 密码:`123456` (演示账号为只读权限)



## 🎁 模块市场

丰富的模块市场,后台一键安装模块应用

![模块市场](https://ms-assets.modstart.com/data/image/2022/01/12/21242_me7h_4616.jpg)

S
develop  
server 已提交
136 137 138 139 140 141 142 143


## 🌐 开发文档

[https://modstart.com/doc](https://modstart.com/doc)


##  🔧 系统安装
S
develop  
server 已提交
144 145 146

### 环境要求

ModStart's avatar
develop  
ModStart 已提交
147 148
- `PHP` `5.6 或 7.0`
- `MySQL` `>=5.0`
S
develop  
server 已提交
149 150 151
- `PHP Extension``Fileinfo`
- `Apache/Nginx`

ModStart's avatar
develop  
ModStart 已提交
152 153
> 强力推荐使用PHP 5.6 或 7.0 版本,系统稳定性最好

ModStart's avatar
develop  
ModStart 已提交
154
### 安装说明
S
develop  
server 已提交
155

S
develop  
server 已提交
156 157
- 宝塔一键安装教程:[https://modstart.com/doc/install/baota.html](https://modstart.com/doc/install/baota.html)
- PHPStudy一键安装教程:[https://modstart.com/doc/install/phpstudy.html](https://modstart.com/doc/install/phpstudy.html)
S
develop  
server 已提交
158
- WampServer安装教程:[https://modstart.com/doc/install/wampserver.html](https://modstart.com/doc/install/wampserver.html)
S
develop  
server 已提交
159
- Docker一键安装教程:[https://modstart.com/doc/install/docker.html](https://modstart.com/doc/install/docker.html)
ModStart's avatar
develop  
ModStart 已提交
160
- 原生环境安装教程:[https://modstart.com/doc/install/start.html](https://modstart.com/doc/install/start.html)
S
develop  
server 已提交
161 162 163 164


### 升级指南

S
develop  
server 已提交
165
参照 [https://modstart.com/doc/install/upgrade.html](https://modstart.com/doc/install/upgrade.html)
S
develop  
server 已提交
166

S
develop  
server 已提交
167

S
develop  
server 已提交
168 169


ModStart's avatar
develop  
ModStart 已提交
170
##  🔨 开发速看
S
develop  
server 已提交
171 172


ModStart's avatar
develop  
ModStart 已提交
173
以下以一个简单的新闻增删改查页面为例,快速了解 ModStart 开发的大致流程。
S
develop  
server 已提交
174

ModStart's avatar
develop  
ModStart 已提交
175
### 数据表迁移文件
S
develop  
server 已提交
176 177 178 179 180 181

```php
class CreateNews extends Migration
{
    public function up()
    {
ModStart's avatar
develop  
ModStart 已提交
182 183 184 185 186 187 188 189
        Schema::create('news', function (Blueprint $table) {
            $table->increments('id');
            $table->timestamps();
            $table->string('title', 200)->nullable()->comment('');
            $table->string('cover', 200)->nullable()->comment('');
            $table->string('summary', 200)->nullable()->comment('');
            $table->text('content')->nullable()->comment('');
        });
S
develop  
server 已提交
190 191 192
    }
    public function down()
    {
ModStart's avatar
develop  
ModStart 已提交
193
        //
S
develop  
server 已提交
194 195 196 197
    }
}
```

ModStart's avatar
develop  
ModStart 已提交
198
### 控制器代码
S
develop  
server 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

```php
class NewsController extends Controller
{
    use HasAdminQuickCRUD;
    protected function crud(AdminCRUDBuilder $builder)
    {
        $builder
            ->init('news')
            ->field(function ($builder) {
                $builder->id('id','ID');
                $builder->text('title', '名称');
                $builder->image('cover', '封面');
                $builder->textarea('summary', '摘要');
                $builder->richHtml('content', '内容');
                $builder->display('created_at', '创建时间');
                $builder->display('updated_at', '更新时间');
            })
            ->gridFilter(function (GridFilter $filter) {
                $filter->eq('id', 'ID');
                $filter->like('title', '标题');
            })
            ->title('新闻管理');
    }
}
```

### 增加路由和导航

`routes.php` 增加路由信息

```php
ModStart's avatar
develop  
ModStart 已提交
231 232 233 234 235
$router->match(['get', 'post'], 'news', 'NewsController@index');
$router->match(['get', 'post'], 'news/add', 'NewsController@add');
$router->match(['get', 'post'], 'news/edit', 'NewsController@edit');
$router->match(['get', 'post'], 'news/delete', 'NewsController@delete');
$router->match(['get', 'post'], 'news/show', 'NewsController@show');
S
develop  
server 已提交
236 237 238 239 240 241 242
```


`ModuleServiceProvider.php` 中注册菜单信息

```php
AdminMenu::register(function () {
ModStart's avatar
develop  
ModStart 已提交
243 244 245 246 247 248 249 250
    return [
        [
            'title' => '新闻管理',
            'icon' => 'list',
            'sort' => 150,
            'url' => '\App\Admin\Controller\NewsController@index',
        ]
    ];
S
develop  
server 已提交
251 252 253
});
```

ModStart's avatar
develop  
ModStart 已提交
254
这样一个简单的新闻增删改查页面就开发完成了。
S
develop  
server 已提交
255 256


S
develop  
server 已提交
257

ModStart's avatar
develop  
ModStart 已提交
258
## 📋 常见问题
S
develop  
server 已提交
259

ModStart's avatar
develop  
ModStart 已提交
260
我们列举了常见问题,请查看官方标准指南
S
develop  
server 已提交
261

ModStart's avatar
develop  
ModStart 已提交
262
[https://modstart.com/doc/install/qa.html](https://modstart.com/doc/install/qa.html)
S
develop  
server 已提交
263

ModStart's avatar
develop  
ModStart 已提交
264
如有其他问题推荐使用官方讨论交流群或在线讨论
S
develop  
server 已提交
265

ModStart's avatar
develop  
ModStart 已提交
266
[https://modstart.com/forum](https://modstart.com/forum)
S
develop  
server 已提交
267