# hnubbs

**Repository Path**: prefer2023/hnubbs

## Basic Information

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

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HNUBBS 论坛项目

这是一个使用前后端分离架构的论坛系统：

- 前端：Vue 3 + Vite
- 后端：Python + FastAPI
- 数据库：MySQL

## 项目结构

```
.
├── app/                    # 后端代码
│   ├── models/             # SQLAlchemy 数据模型
│   │   └── __init__.py     # ORM 模型定义
│   ├── routers/            # API 路由
│   │   ├── auth.py         # 认证相关路由
│   │   ├── users.py        # 用户相关路由
│   │   ├── boards.py       # 板块相关路由
│   │   ├── posts.py        # 帖子相关路由
│   │   ├── comments.py     # 评论相关路由
│   │   ├── tags.py         # 标签相关路由
│   │   ├── reports.py      # 举报相关路由
│   │   └── search.py       # 搜索相关路由
│   ├── schemas.py          # Pydantic 数据验证模型
│   ├── crud.py             # 数据库操作
│   ├── database.py         # 数据库配置
│   ├── deps.py             # 依赖项
│   ├── config.py           # 应用配置
│   └── __init__.py         # 包初始化文件
├── frontend/               # 前端代码 
├── sql/                    # 数据库脚本
│   ├── create_table.sql    # 创建表结构
│   ├── drop_tables.sql     # 删除表结构
│   └── insert_demo_data.sql # 示例数据SQL
├── requirements.txt        # 后端依赖
├── main.py                # 后端入口文件
├── .env                   # 环境变量配置
├── .gitignore             # Git忽略文件配置
└── README.md              # 项目说明文件
```

## 快速开始

### 后端启动

1. 创建并激活虚拟环境：
   ```bash
   python -m venv hnubbs-env
   hnubbs-env\Scripts\activate     # Windows
   ```

2. 安装依赖：
   ```bash
   pip install -r requirements.txt
   ```

3. 初始化数据库：
   执行 `sql\backup.sql` 的sql语句创建数据库 `hnubbs`
   ``` sql
   -- 创建数据库用户 philia093，密码：philia093
   CREATE USER 'philia093'@'%' IDENTIFIED BY 'philia093';
   
   -- 将hnubbs数据库的所有权限授予 philia093
   GRANT ALL PRIVILEGES ON hnubbs.* TO 'philia093'@'%';
   ```

4. 运行后端服务：
   ```bash
   python main.py
   ```
   
5. 运行前端服务
   ``` bash
   cd frontend
   npm install    # 安装依赖
   npm run dev    # 启动网页服务器
   ```

6. 访问网站 http://localhost:3000/

## API 文档

后端 API 文档可通过以下地址访问：
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc

## 项目特点

- 完整的用户认证和授权系统（JWT Token）
- 板块、帖子、评论管理
- 标签系统
- 点赞、收藏功能
- 举报系统
- RESTful API 设计
- 数据库关系完整（外键约束）