2 Star 8 Fork 3

牛牛 / n-admin

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
AFL-3.0

演示地址

http://n.niu6666.top

帐号admin 密码123456

代码规范

A、代码规范

1、后端的方法命名统一采用驼峰的方式

2、全局函数只允许封装与业务无管函数,不建议过多封装全局函数

3、尽量面向对象编程

4、逻辑判断不建议超过三层

5、方法封装要符合单一职责,一个方法只解决一个问题,理论上方法不允许超过80行代码,最好控制在30行以内

B、数据库规范

1、严禁使用Db,所有数据库操作使用model

2、严禁在model层里面写业务逻辑

3、严禁在controller层里面直接操作数据库

4、表名、字段名严格按照laravel规范

5、禁止使用join语句,尽量封装关联模型

6、数据库结构更改必须走迁移,为减少迁移文件数量,上线之前可以不使用新增迁移

7、建议使用修改器,不建议在模板文件里处理数据

8、枚举类型的数据,建议封装model常量

C、其他

1、严格准守逻辑分层:model->repository->controller->view;

2、统一在repository里面写业务逻辑,采用注入的方式在controller层里面调用

3、如需对model进行封装,可采用traits;与业务逻辑无管的服务可以额外添加service层,直接注入到repository或controller,架构分层不可逆

4、所有与环境有关的配置必须走env,config中调用env,业务中调用config。本地.env 里添加变量时 必须 同步到 .env.example 中

5、必须保证测试代码与生产代码完全一致

6、如有任务、队列、脚本等,一定要在此文档里以表格形式罗列出,说明用途,指出调用场景

7、建议采用统一的代码格式化风格

8、建议使用表单验证

逻辑分层

avatar

环境要求

  • mysql 5.7 php7.4

项目部署

  • 安装扩展 sudo composer install 生产环境执行 composer install --no-dev
  • 运行迁移 sudo php artisan migrate
  • 重启队列 sudo php artisan queue:restart

项目开发常用命令

1,拉取代码后,更新数据库结构

php artisan migrate

2,拉取代码后,重建数据库并填充数据

php artisan migrate:refresh --seed

如果提示某个种子类找不到,需要执行

composer dump-autoload

3,创建模型和迁移

php artisan make:model Model/模型名 -m

4,拉取代码后,安装扩展

composer install

5,从本地数据库生成种子,主要是基础数据表

php artisan iseed 表名

项目开发调试助手(只有local环境有效)

1,在开发环境收集 dump() 函数输出,并将其打印到控制台或导出到文件,不在页面展示dump信息

php artisan dump

2,在浏览器查看数据库执行情况

在浏览器安装clockwork扩展

3, Telescope调试工具

访问 /test 可查看系统的所有运行信息,具体路径根据本地配置

4,创建模型后,更新ide-help,便于代码提示

php artisan ide-help:model

no

自定义模板标签

1,myAuth

在页面中判断是否有操作权限,参数为操作的url

@myAuth('/admin/coupon/stop')
    <span data-id="" class="layui-btn layui-btn-sm layui-btn-danger">停用</span>';
@endmyAuth

自定义脚本

命令 说明

定时任务

命令 执行方式 频率 说明

对外提供接口

为外部系统提供接口,使用sign签名,签名方式参考微信签名

验签方式已封装为中间件

签名密钥配置

config/constant.php

return [
    'app_key' => env('MY_APP_KEY', 'abc'),  //对外部提供接口的密钥
];
路由文件

routes/app.php

Route::post('/test', 'TestController@test');
控制器文件

app/Http/Controllers/App/TestController.php

class TestController extends Controller
{
    public function test(Request $request)
    {
        return $this->success('成功', $request->input());
    }
}
使用方式

avatar

Docker使用建议

  • 1,在conf文件夹下创建不同环境的env配置,编写makefile,配置相应环境的创建执行脚本

  • 2,mysql,redis建议不要使用容器,最好使用云服务商的

  • 3,使用dockerfile构建好镜像,然后创建容器,绑定80和443端口。在容器中执行make test,就可以直接访问了。

Academic Free License (“AFL”) v. 3.0 This Academic Free License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following licensing notice adjacent to the copyright notice for the Original Work: Licensed under the Academic Free License version 3.0 1) Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following: a) to reproduce the Original Work in copies, either alone or as part of a collective work; b) to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby creating derivative works ("Derivative Works") based upon the Original Work; c) to distribute or communicate copies of the Original Work and Derivative Works to the public, under any license of your choice that does not contradict the terms and conditions, including Licensor’s reserved rights and remedies, in this Academic Free License; d) to perform the Original Work publicly; and e) to display the Original Work publicly. 2) Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works. 3) Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work. 4) Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as expressly stated herein, nothing in this License grants any license to Licensor’s trademarks, copyrights, patents, trade secrets or any other intellectual property. No patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims other than the licensed claims defined in Section 2. No license is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license. 5) External Deployment. The term "External Deployment" means the use, distribution, or communication of the Original Work or Derivative Works in any way such that the Original Work or Derivative Works may be used by anyone other than You, whether those works are distributed or communicated to those persons or made available as an application intended for use over a network. As an express condition for the grants of license hereunder, You must treat any External Deployment by You of the Original Work or a Derivative Work as a distribution under section 1(c). 6) Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent, or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work. 7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately preceding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer. 8) Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to anyone for any indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation. 9) Acceptance and Termination. If, at any time, You expressly assented to this License, that assent indicates your clear and irrevocable acceptance of this License and all of its terms and conditions. If You distribute or communicate copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. This License conditions your rights to undertake the activities listed in Section 1, including your right to create Derivative Works based upon the Original Work, and doing so without honoring these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations (including “fair use” or “fair dealing”). This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to honor the conditions in Section 1(c). 10) Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware. 11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License. 12) Attorneys’ Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License. 13) Miscellaneous. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. 14) Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. 15) Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You. 16) Modification of This License. This License is Copyright © 2005 Lawrence Rosen. Permission is granted to copy, distribute, or communicate this License without modification. Nothing in this License permits You to modify this License as applied to the Original Work or to Derivative Works. However, You may modify the text of this License and copy, distribute or communicate your modified version (the "Modified License") and apply it to other original works of authorship subject to the following conditions: (i) You may not indicate in any way that your Modified License is the "Academic Free License" or "AFL" and you may not use those names in the name of your Modified License; (ii) You must replace the notice specified in the first paragraph above with the notice "Licensed under <insert your license name here>" or with a notice of your own that is not confusingly similar to the notice in this License; and (iii) You may not claim that your original works are open source software unless your Modified License has been approved by Open Source Initiative (OSI) and You comply with its license review and certification process.

简介

基于Laravel8,xadmin2.2,layui2.5.7开发的后台管理系统 展开 收起
AFL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
PHP
1
https://gitee.com/niu888/n-admin.git
git@gitee.com:niu888/n-admin.git
niu888
n-admin
n-admin
master

搜索帮助