# pythonstyle-vue

**Repository Path**: chinacsj123/pythonstyle-vue

## Basic Information

- **Project Name**: pythonstyle-vue
- **Description**: PythonStyle是一个企业级开发框架，采用MVC架构，统一入口，自动实现访问路由。内置模块包含：用户管理、部门管理、角色管理、菜单及按钮授权、日志管理、登录模块等。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 13
- **Forks**: 3
- **Created**: 2025-01-16
- **Last Updated**: 2026-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PyCodev Vue3 v2.0

PyCodev 是一个面向企业后台场景的 Python 全栈开发框架，当前版本由 `ASGI + Uvicorn` 后端和 `Vue 3 + Element Plus` 管理端组成。

项目默认聚焦四类框架能力：
- 系统管理
- 系统监控
- 流程管理
- 表单管理

## 核心特性

- 保留 `m/c/a` 开发组织方式，便于继续扩展后台业务模块
- 后端统一返回结构、统一配置加载、统一权限控制链路
- 内置登录认证、菜单权限、验证码、操作日志、登录日志、定时任务
- 提供流程定义、流程运行时、表单设计、表单数据管理基础能力
- 支持 MySQL、Redis、任务调度、多环境配置与迁移脚本管理

## 目录结构

```text
.
├── main.py
├── scheduler_main.py
├── pycodev/
├── resources/
├── vue/
├── doc/
├── tools/
├── static/
├── logs/
├── artifacts/
├── requirements.txt
└── gunicorn_run.sh
```

后端主目录说明：

```text
pycodev/
├── app.py
├── core/
├── libs/
├── common/
├── model/
├── config/
└── modules/
    ├── flow/
    ├── form/
    ├── monitor/
    ├── system/
    └── test/
```

前端主目录说明：

```text
vue/src/
├── api/
├── assets/
├── components/
├── directive/
├── layout/
├── router/
├── stores/
├── utils/
└── views/
    ├── flow/
    ├── form/
    ├── monitor/
    ├── system/
    ├── login.vue
    ├── register.vue
    └── index.vue
```

## 环境要求

- Python 3.10+
- Node.js 18+
- MySQL 8+
- Redis 6+（推荐）

## 后端启动

安装依赖：

```bash
pip install -r requirements.txt
```

直接启动：

```bash
python main.py
```

或使用 Uvicorn：

```bash
python -m uvicorn main:app --host 127.0.0.1 --port 8081
```

独立启动调度器：

```bash
python scheduler_main.py
```

## 前端启动

```bash
cd vue
npm install
npm run dev
```

生产构建：

```bash
cd vue
npm run build
```

## 配置说明

主要配置文件位于 `resources/`：

- `application.yml`
- `application-dev.yml`
- `application-ci.yml`
- `application-loadtest.yml`
- `application-pro.yml`
- `application-pro.example.yml`

默认开发库配置位于 [resources/application-dev.yml](D:\python_workspace\pycodev-vue3-v2.0\resources\application-dev.yml)。

## 数据迁移

查看待执行迁移：

```bash
python tools/run_migrations.py --profile dev --dry-run
```

执行迁移：

```bash
python tools/run_migrations.py --profile dev
```

## 常用检查

语法检查：

```bash
python -m py_compile main.py scheduler_main.py
```

乱码与编码检查：

```bash
python tools/check_mojibake.py
python tools/check_text_encoding.py
```

## 开发约束

- Python 使用 4 空格缩进
- 文件名、模块名使用 `snake_case`
- 后端接口统一通过 `Result.success()` / `Result.error()` 返回
- 新增业务优先放在 `pycodev/modules/<domain>/controller` 和 `entity`
- 当前前端接口目录保留 `vue/src/api/sysetm/` 这一既有拼写以兼容旧代码

## 部署建议

推荐使用：

- `Nginx`
- `Gunicorn + UvicornWorker`
- `MySQL`
- `Redis`

相关部署模板位于 `tools/deploy/`。