# peihuapp

**Repository Path**: nxshare/peihuapp

## Basic Information

- **Project Name**: peihuapp
- **Description**: 陪护APP后台和接口
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-23
- **Last Updated**: 2021-03-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


## 安装

- git clone 到本地
- 切换阿里云镜像地址 composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/
- 执行 ` composer install --ignore-platform-reqs`,`npm install`创建好数据库
- 配置 **.env** 中数据库连接信息,修改为自己数据库相关信息，没有.env请复制.env.example命名为.env
- 执行 `php artisan key:generate`
- 执行 `php artisan migrate`
- 执行 `php artisan db:seed`
- 确保storage下所有目录 和 bootstrap/cache 目录应该是可写的
- 配置相关nginx规则域名解析到/public目录
- 键入 '域名/admin/login'(后台登录)
- 测试用户名：user1；密码：123456
- 执行apidoc命令时 确保已经全局安装apidoc 
- 如果没有安装执行 npm install apidoc -g
- 生成文档 apidoc -i app/Http/Controllers/Api/V1 -o public/apidoc error(todo)
- 执行命令后生成的api文档在public/apidoc里面
- 在项目根目录配置项目接口文档说明，新建 apidoc.json
- {
-    "name": "项目说明",
-    "version": "3.1.0",
-    "description": "项目描述",
-    "title": "项目标题",
-    "url" : "http://test.com/"
- }

##框架说明
- 代码自动生成
    - 视图文件
        - 列表文件：支持分页、排序、搜索
    - 控制器文件
    - 模型文件
    - 自动生成服务
    - 自动生成菜单列表
- 功能说明
    - 支持功能模块自动增删改查
    - 支持权限系统
    - 支持角色管理系统
    - 支持H5文本内容检查合法性(\public\base\js\plugins\validate\test.html)
    - excel导入导出
    - 阿里发送短信
- api接口token认证流程
    - 前端用户注册成功生成token保存至用户表中
    - 通过auth::user()认证
    - 在请求接口中需要加入api_token字段，或者在header中加入 字段名为 Authorization ，值为 Bearer $token
 

##框架使用手册
- 建表规范
    - 每张表都应该设置合理的字段类型和字段注释,在后台curd中会根据字段注释生成对应的列表显示名称，根据字段类型生成对应的文本类型
        - tinyint  单选框  （切记 先在字典表base_dictionaary_option配置单选框选项）
        - text     富文本编辑器  （富文本图片默认上传至本地可配置上传至ali等）
        - datetime 时间插件 
        - 字段名为（path、image、avatar、logo、\*_path、\*_image、\*_avatar、\*_logo）生成图片上传插件
        
##TODO
- 菜单的缓存管理
- 菜单的公共权限

## USEFUL LINK
- dingo/api [https://github.com/dingo/api](https://github.com/dingo/api)
- transformer [fractal](http://fractal.thephpleague.com/)
- apidoc [apidocjs](http://apidocjs.com/)
- 参考文章 [http://oomusou.io/laravel/laravel-architecture](http://oomusou.io/laravel/laravel-architecture/)
- debug rest api [postman](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en)