# topicPrimary

**Repository Path**: ElloitYu/topic-primary

## Basic Information

- **Project Name**: topicPrimary
- **Description**: 小学试题后台管理
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-24
- **Last Updated**: 2024-06-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# saas-web
* 臣信SAAS端项目
* 基于Vue3 + Typescript + Sass + Tailwindcss + Axios + ElementPlus 开发的单页应用


## 安装依赖
* 执行：pnpm install 或 pnpm i


## 本地运行
* pnpm dev 调试正式网站


## 打包
* pnpm build 打包


## 目录结构

**公共目录 assets**
* 所有公用资源文件都放于 根目录/src/assets目录，包括css、image、font等

**单个网页** 
* 所有页面都放于 根目录/src/views目录下

**公共组件**
* 放于根目录/src/components下
* 项目专用公共组件

## 目录结构图形
├── dist                 // 打包资源
├── public                 // 公用资源
├── src
│   │── Assets           // 静态资源
│   │   ├── Css          // 公共css文件夹
│   ├── Components       // 公共组件库
│   ├── Router           // 路由配置
│   ├── Utils            // 公共设施
│       ├── request      // 请求相关函数
│   └── Views            // 页面文件夹
│       ├── Home         // 首页
│       ├── Login        // 登录页面
│       └── modules      // 其他页面文件夹
                

## 文件命名规范
**文件夹命名规范**
* 采用大小写字母组合，首字母大写的驼峰式写法，缩写全大写写法

**VUE文件命名规范**
* 采用大小写字母组合，首字母大写的驼峰式写法

**JS、TS文件命名规范**
* 采用大小写字母组合，首字母小写的驼峰式写法

**SASS、CSS文件命名规范**
* 采用大小写字母组合，首字母小写的驼峰式写法


# 代码规范
**代码编写规范**
* 采用空格缩进，4个空格为一个缩进。请更改IDE的Tab为4个空格。
* 函数()后面加一个空格 如 function add () {}，主要是为了方便查找函数，不会查询到调用该函数的地方
* 每行逻辑处理结束后面加分号: ";"
        
***js变量命名***
* 命名要见面知意，如，`game`,`isPlayGame` 除非是特殊的词语，如`alibaba` `taobao` 否则不要用拼音 。错误：`youxi`  ` v1` `v2` `v3` 。
* 变量命名采用首字母小写的驼峰形式，如`isNode` `testValue`,错误示范：`test_value`
* 静态变量采取大写字母组合"_"下划线连接，如`MESSAGE_TYPE"`
* 方法命名与变量一致，静态工具类首字母大写,如`Cache XCanvas`
* 必须加注释
        
***函数命名***
* 命名要见面知意，如，`game`,`isPlayGame` 除非是特殊的词语，如`alibaba` `taobao` 否则不要用拼音 。错误：`youxi`  ` v1` `v2` `v3` 。
* 变量命名采用首字母小写的驼峰形式，如`isNode` `testValue`,错误示范：`test_value`
* 静态变量采取大写字母组合"_"下划线连接，如`MESSAGE_TYPE"`
* 方法命名与变量一致，静态工具类首字母大写,如`Cache XCanvas`
* 必须加注释
        
***css变量命名***
* 命名要见面知意，如，`game`,`is-play-game` 除非是特殊的词语，如`alibaba` `taobao` 否则不要用拼音 。错误：`youxi`  ` v1` `v2` `v3` 。
* 变量命名采用首字母小，单词间用`-`分割的形式，如`is-node` `test-value`, 错误示范：`test_value` `testValue`
        
***类型变量命名***
* 变量命名采用首字母大写的驼峰形式，如`NodeType` `TestType`,错误示范：`testValue`、`test_value`
* 必须加注释

***接口提示***
* 统一读取msg字段作为消息提示内容

***Element表格***
* 超过3按钮个，除了修改、删除，其他都放进操作里面
* 加载中在表格里显示
* 没有数据显示"暂无数据"
* 操作列中间对齐
* 其他信息列左边对齐
* 当内容过长被隐藏时显示 tooltip
* 分页默认20条
* 操作列固定于右边

***没有权限的按钮***
* 显示出来，禁用状态

***表格***
* 名字、标签定死，最小80px
* 日期，最小160px