# 基础工程仓库

**Repository Path**: hanxuming/baseProject

## Basic Information

- **Project Name**: 基础工程仓库
- **Description**: 用于存储常用的基础工程：mobile移动端vue项目、manage管理台、node服务器接口
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-05
- **Last Updated**: 2026-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 基础工程仓库

全栈脚手架集合，包含 PC 端管理台、移动端 H5 和 Node.js 后端三个独立项目，开箱即用。另附 jQuery 4.0.0 源码供直接引用。

## 子项目

| 项目 | 目录 | 说明 | 技术栈 |
| --- | --- | --- | --- |
| PC 管理台 | `vite-base-pc/` | 中后台管理系统脚手架 | Vue 3 + Element Plus |
| 移动端 | `vite-base-mobile/` | 移动端 H5 应用脚手架 | Vue 3 + Vant 4 |
| 后端服务 | `koa-base-server/` | Node.js 后端服务模版 | Koa 2 + Sequelize + PostgreSQL |
| jQuery | `jquery-4.0.0.js` | jQuery 4.0.0 源码（根目录公共资源） | jQuery 4 |

## 技术栈

- **框架**：Vue 3 + Vue Router 4 + Pinia
- **构建**：Vite（含 legacy 兼容）
- **网络**：Axios（统一封装、拦截器）
- **样式**：Less + normalize.css + autoprefixer
- **Mock**：vite-plugin-mock + mockjs
- **自动导入**：unplugin-auto-import + unplugin-vue-components

## 快速开始

### 环境要求

- Node.js >= 14.13.0（或 >= 12.20.0）

### PC 管理台

```bash
cd vite-base-pc
npm install
npm run dev           # 启动开发服务器
npm run build         # 生产构建
npm run build:mock    # 构建并保留 mock 数据
npm run serve         # 预览构建产物
```

### 移动端

```bash
cd vite-base-mobile
npm install
npm run dev           # 启动开发服务器
npm run build         # 生产构建（mode=prod）
npm run build:dev     # 构建测试环境（mode=staging）
```

### 后端服务

```bash
cd koa-base-server
npm install
cp .env.example .env  # 配置数据库连接和 JWT 密钥
npm run dev           # 开发模式（自动重启）
npm run start         # 生产模式
```

## 项目结构

```
baseProject/
├── vite-base-pc/         # PC 端管理台
│   ├── mock/             # 接口 mock 数据
│   ├── src/
│   │   ├── layouts/      # 管理台布局（侧栏 + 头部 + 多标签页）
│   │   ├── router/       # 路由配置（含侧栏菜单、权限）
│   │   ├── service/      # 接口封装
│   │   ├── store/        # Pinia 状态管理
│   │   ├── components/   # 全局组件
│   │   ├── config/       # 多环境配置（dev / staging / prod）
│   │   ├── plugins/      # 指令 / mitt / SVG 图标
│   │   ├── util/         # 工具函数
│   │   └── view/         # 业务页面
│   └── vite.config.js
├── vite-base-mobile/     # 移动端 H5
│   ├── mock/             # 接口 mock 数据
│   ├── src/
│   │   ├── router/       # 路由配置
│   │   ├── service/      # 接口封装
│   │   ├── store/        # Pinia 状态管理
│   │   ├── components/   # 全局组件（Loading / Toast 等函数式组件）
│   │   ├── config/       # 多环境配置
│   │   ├── plugins/      # 指令 / mitt
│   │   ├── util/         # 工具函数（含 rem 适配）
│   │   └── view/         # 业务页面
│   └── vite.config.js
└── koa-base-server/      # Node.js 后端服务
    ├── app.js            # 入口文件
    ├── dbs/              # 数据库（Sequelize 模型定义）
    ├── router/           # 路由（自动扫描注册）
    ├── controller/       # 控制器层
    ├── service/          # 服务层
    ├── middleware/        # 中间件（JWT 认证、CORS）
    └── util/             # 工具模块
```

## 核心功能

### PC 端管理台

- 管理台布局：侧边栏 + 头部 + 面包屑 + 多标签页
- 路由统一管理菜单、权限、面包屑
- Element Plus 按需自动引入
- SVG 图标系统
- 自定义指令（v-backtop / v-draggable / v-maxlength）
- 全屏展示
- 加载进度条（NProgress）

### 移动端

- Vant 4 组件按需自动引入
- rem 适配方案
- 函数式组件（Loading / Toast）
- 自定义指令（v-backtop / v-draggable）
- 调试工具 vConsole

### 后端服务

- Koa 2 + koa-router 分层架构（router → controller → service → model）
- 路由自动扫描注册（新增文件即可，无需改 app.js）
- JWT 认证中间件（白名单配置）
- CORS 跨域配置
- Sequelize ORM + PostgreSQL 自动建表
- dotenv 环境变量管理
- 统一响应格式工具
- 可选：OpenAI SDK 客户端封装

## 多环境配置

前端项目支持多环境，通过 Vite `--mode` 参数切换：

| 环境 | mode 值 | 配置文件 |
| --- | --- | --- |
| 开发 | `dev` | `src/config/env.dev.js` |
| 测试 | `staging` | `src/config/env.staging.js` |
| 生产 | `prod` | `src/config/env.prod.js` |

后端项目通过 `.env` 文件管理配置，复制 `.env.example` 并填写实际值即可。

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

## 相关链接

- [Vue 3 文档](https://v3.cn.vuejs.org/)
- [Vite 文档](https://cn.vitejs.dev/)
- [Element Plus](https://element-plus.gitee.io/zh-CN/)
- [Vant 4](https://vant-ui.github.io/vant/)
- [Pinia](https://pinia.vuejs.org/zh/)
- [Koa 2](https://koajs.com/)
- [Sequelize](https://sequelize.org/)
- [PostgreSQL](https://www.postgresql.org/)