# express_ts_mySql

**Repository Path**: PF-Wang/express_ts_my-sql

## Basic Information

- **Project Name**: express_ts_mySql
- **Description**: node+ts+express+mysql
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Express TypeScript MySQL 项目

这是一个使用 Express.js + TypeScript + MySQL 构建的后端服务项目，提供了用户管理、文件上传、商品管理等功能。

## 功能特性

- 用户认证与授权（登录、注册、登出）
- 文件上传和管理
- 商品管理系统
- 个人信息管理
- 代码数据管理
- 分页查询支持
- 日志记录系统

## 技术栈

- Express.js - Web 应用框架
- TypeScript - 类型安全的 JavaScript 超集
- MySQL - 数据库
- Node.js - 运行时环境
- Jade - 模板引擎
- JWT - 用户认证
- Multer - 文件上传处理

## 项目结构

```
├── src/                # 源代码目录
│   ├── controller/     # 控制器层
│   ├── database/       # 数据库配置
│   ├── entity/         # 实体定义
│   ├── model/          # 数据模型
│   ├── routes/         # 路由定义
│   ├── types/          # 类型定义
│   ├── utils/          # 工具函数
│   ├── app.ts          # 应用配置
│   └── server.ts       # 服务器入口
├── public/             # 静态资源
├── views/              # 视图模板
└── dist/               # 编译输出目录
```

## 开始使用

### 环境要求

- Node.js >= 14.x
- MySQL >= 5.7
- TypeScript >= 4.x

### 安装

1. 克隆项目

```bash
git clone [项目地址]
cd express_ts_mysql
```

2. 安装依赖

```bash
npm install
```

3. 配置数据库

- 创建 MySQL 数据库
- 配置数据库连接信息

### 开发

```bash
# 开发模式
npm run server

# 构建
npm run build

# 生产环境运行
npm start
```

## API 文档

### 用户相关

- POST `/login` - 用户登录
- POST `/register` - 用户注册
- POST `/loginOut` - 用户登出

### 文件管理

- POST `/upload` - 上传文件
- DELETE `/deleteFile` - 删除文件

### 商品管理

- GET `/goods` - 获取商品列表
- POST `/goods` - 创建商品
- PUT `/goods/:id` - 更新商品
- DELETE `/goods/:id` - 删除商品

## 开发规范

- 使用 TypeScript 编写代码，确保类型安全
- 遵循 RESTful API 设计规范
- 使用模块别名提高代码可维护性
- 统一错误处理和响应格式

## 部署

1. 构建项目
```bash
npm run build
```

2. 运行服务
```bash
npm start
```

服务默认运行在 `http://localhost:3001`

## 注意事项

- 确保数据库配置正确
- 文件上传目录权限设置
- 生产环境的安全配置
- 日志文件管理