# big-event-ui

**Repository Path**: JabinL/big-event-ui

## Basic Information

- **Project Name**: big-event-ui
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-20
- **Last Updated**: 2026-02-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 大事件 (Big Event)

> Vue 3 + Vite + Element Plus + Pinia 后台管理系统

## 技术栈

- **框架**: Vue 3 (Composition API + `<script setup>`)
- **构建工具**: Vite
- **UI 组件库**: Element Plus
- **状态管理**: Pinia + pinia-persistedstate-plugin
- **路由**: Vue Router 4
- **HTTP 请求**: Axios
- **富文本编辑器**: Vue Quill
- **代码规范**: ESLint + Prettier + Husky + lint-staged + Commitlint

## 项目结构

```
src/
├── api/              # API 接口封装
├── assets/           # 静态资源
├── router/           # 路由配置
├── stores/           # Pinia 状态管理
│   ├── token.js      # Token 存储
│   ├── userInfo.js   # 用户信息存储
│   └── auth.js       # 鉴权相关（登出等）
├── utils/
│   └── request.js    # Axios 实例封装
├── views/            # 页面组件
│   ├── Login.vue     # 登录/注册页
│   ├── Layout.vue    # 主布局
│   ├── article/      # 文章管理
│   └── user/         # 用户中心
├── App.vue
└── main.js
```

## 开发环境

### 前置条件

- Node.js >= 22
- npm >= 9

### 安装依赖

```sh
npm install
```

### 启动开发服务器

```sh
npm run dev
```

开发服务器会在 `http://localhost:5173` 启动。

### 代码检查与格式化

```sh
# ESLint 检查
npm run lint

# ESLint 自动修复
npm run lint:fix

# Prettier 格式化
npm run format
```

## 后端服务配置

### 代理配置

开发环境通过 Vite 代理转发 API 请求，配置在 `vite.config.js`：

```javascript
server: {
  proxy: {
    '/api': {
      target: 'http://localhost:8080',  // 后端服务地址
      changeOrigin: true,
      rewrite: (path) => path.replace(/^\/api/, '')
    }
  }
}
```

### 接口约定

- 基础路径: `/api`
- 响应格式:
  ```json
  {
    "code": 0, // 0 表示成功，非 0 表示失败
    "msg": "操作成功",
    "data": {} // 业务数据
  }
  ```
- 认证方式: 请求头携带 `Authorization: <token>`

## 构建部署

### 构建生产版本

```sh
npm run build
```

构建产物输出到 `dist/` 目录。

### 预览生产构建

```sh
npm run preview
```

## 提交规范

项目使用 [Conventional Commits](https://www.conventionalcommits.org/) 规范：

```
<type>(<scope>): <subject>

# 示例
feat: 添加用户登录功能
fix: 修复文章列表分页问题
docs: 更新 README
chore: 更新依赖版本
```

常用 type：

- `feat`: 新功能
- `fix`: Bug 修复
- `docs`: 文档更新
- `style`: 代码格式（不影响功能）
- `refactor`: 重构
- `chore`: 构建/工具变动