# back_system_api

**Repository Path**: manongnianjiu/back_system_api

## Basic Information

- **Project Name**: back_system_api
- **Description**: 专注于后台管理系统开发的开源项目，提供高效、稳定的技术支持，适用于多种企业级应用场景。技术栈: express+mysql
- **Primary Language**: JavaScript
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-26
- **Last Updated**: 2025-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Back System 后台管理系统

基于 Express + MySQL 的 RESTful API 后台管理系统，包含用户管理、权限验证、数据库操作等功能。

## 技术栈

- **后端框架**: Express.js
- **数据库**: MySQL (通过mysql2驱动)
- **认证**: JWT Token
- **代码规范**: ESLint + Prettier
- **Git提交规范**: Commitizen + Husky

## 功能特性

- 用户登录/注册
- JWT Token 验证
- 用户增删改查
- 数据库连接池管理
- 请求参数校验 (Joi)
- 统一错误处理

## 环境要求

- Node.js >= 16.x
- MySQL >= 5.7

## 安装步骤

```bash
# 克隆项目
git clone https://your-repository-url.git
cd back_system

# 安装依赖
npm install

# 复制环境变量文件
cp .env.example .env
```
## 配置说明 (.env)
```ini
PORT=4300                 # 服务端口
BASE_URL=/api             # API基础路径
JWT_SECRET=your_secret    # JWT密钥

# MySQL 配置
SQL_HOST=localhost
SQL_PORT=3306
SQL_USER=root
SQL_PASSWORD=your_password
SQL_DATABASE=your_database
```
## 运行命令
```bash
# 开发模式 (带热更新)
npm start

# 代码检查
npm run lint

# 自动修复代码格式
npm run lint:fix

# 交互式提交 (遵循Angular提交规范)
npm run commit
```
## 目录结构
```plainText
back_system/
├── src/
│   ├── db/          # 数据库模块
│   ├── middleware/  # 中间件
│   ├── routes/      # 路由控制器
│   ├── utils/       # 工具函数
│   └── app.js       # Express主应用
├── bin/             # 启动脚本
└── .env             # 环境变量配置
```
## 贡献指南
 - 遵循现有代码风格
 - 重要修改需添加单元测试
 - 提交前执行 npm run lint:fix
 - 使用 npm run commit 进行规范提交