# calmshop

**Repository Path**: Calm-Chan/calmshop

## Basic Information

- **Project Name**: calmshop
- **Description**: 重构商城项目
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-07-10
- **Last Updated**: 2024-07-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Laradoc
## 工具
docker
docker-compose
docker-sync
node npm

## 初始化shop项目
### h5项目
复制项目到laravel-shop目录下
```shell script
npm install 
npm run dev
```

### laradoc
### 修改配置文件
env配置路径
```dotenv
APP_CODE_PATH_HOST=../../
```
nginx配置conf文件

### laravel
package.json 配置启动命令
```text
        "h5": "cd ./h5 && npm run dev",
        "up": "cd ./laradock && sudo sh sync.sh up workspace nginx redis mysql",
        "down": "cd ./laradock && sudo sh sync.sh down",
        "up-w": "cd ./laradock && sudo sh sync.sh up workspace"
```
## laravel代码规范
### 代码格式化
- 代码格式 laravel风格
code style
- 代码提交经过格式化 + 优化导入
format code
optimize imports 

### 编码格式规范
- 短函数，单函数不超过80行，最好40以内，一个函数只做好一件事，有明确的输入输出
- 有意义的函数命名，动宾结构，加上必要的函数注释
- 常量，所有的字母都必须大写，词间下划线分隔 如API_VERSION
- 属性，小写开头驼峰，比如 $adminUser
- 类函数，小写开头驼峰 比如getUser
- 不允许拼音命名，除非专有名词，比如人民币 yuan
- 尽可能使用已有的开源组件，不自己造轮子
- 路由，保留原项目规范，使用具体接口语义，get post
- 异常情况记录错误日志， 方便排查
- 响应格式规范会

### 数据库规范
- 表名、字段全小写，下划线分隔单词，见名知意
- 表设计默认存在 id, add_time,update_time,deleted 四个字段
- 不使用存储过程、视图、触发器、Event
- 禁止使用外键
外键会导致表与表耦合
- 禁止使用enum,使用tinyint代替
- 数据库操作不能使用原生sql，使用查询构造器进行语句构建