# wassui

**Repository Path**: Y_yyyy/wassui

## Basic Information

- **Project Name**: wassui
- **Description**: 实习后台系统项目
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: CM-3161
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-30
- **Last Updated**: 2024-10-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WebSOC

## 特性清单

TODO

## 初始化研发环境

```
# 首先使用 virtualenv 或 pyenv virtualenv 创建 Python 3 的虚拟环境 
`virtualenv -p python3 py3env`

# 前端依赖安装  node > 14
# node > 14

curl -fsSL https://deb.nodesource.com/setup_16.x | sudo bash -
apt-get install -y nodejs make
npm config set registry https://registry.npm.taobao.org
npm install -g yarn
yarn config set registry https://registry.npm.taobao.org

# 安装依赖
make install  # 前后端全部安装
make install_ui   # 只安装前端依赖
make install_server   # 只安装后端 python 依赖

# 运行后端
make run_server HOST=8000

# 运行前端
# 修改 client/vite.config.js 后端代理地址为 本机
make run_ui 

```

## 基本信息

1. 项目脚手架 `Umi`
2. 前端框架 `React`
3. UI库 `Antd` + `自研react-component`
4. 数据请求 `fetch`
5. 图标库 `Echarts`
6. 后端 `python` + `Django`
7. 数据库 `MongoDB`
8. node `版本>14`

## 命名规范

1. 国际化(key)
  - client -> 小驼峰（eg：`page.target.addTarget`）
  - server -> 下划线（eg: `task_repeat`）
2. css -> 小驼峰（因为启用了`css Modules`方案，索性直接使用小驼峰方便引用）
3. 常量 -> 全大写加下划线（eg：`TARGET_MODE`）
4. model(server) -> 直接以`collection`来命名

## `Git`提交规范

1. 分支名 
  - `feature/`
  - `features/`
  - `bugfix/`
  - `hotfix/`
  - `stable/`
  - `ship/`

2. commit信息
  `<type>:<subject>#<jira ID>` （eg：`feat: 新增目标管理页面#WASS-123`）

3. python 代码格式化
  `make format`

4. python 代码静态检查
  `make lint`