# nfu-town

**Repository Path**: limou3434/nfu-town

## Basic Information

- **Project Name**: nfu-town
- **Description**: 南苑小镇项目源代码
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-31
- **Last Updated**: 2025-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NFU Town

## 项目简介

**NFU Town** 是一款基于 Koa.js 和 Vue3 开发的小镇管理平台，采用前后端分离架构，并通过 Docker 容器化部署。平台提供用户管理、小镇管理、商家管理、文章管理、图片存储等功能，为用户提供高效、稳定的服务。

## 代码仓库

- GitHub 仓库：[limou3434/nfu-town](https://github.com/limou3434/nfu-town)

## 技术架构

### 后端技术栈
- **Koa.js**：轻量级 Node.js 后端框架
- **MongoDB**：NoSQL 数据存储
- **Mongoose**：MongoDB 的 ORM 操作
- **koa-router**：设计 Restful API
- **koa-bodyparser**：解析请求体
- **koa-static**：提供静态资源服务
- **JWT**：用户身份验证
- **自定义日志 & 错误处理**：增强系统稳定性

### 前端技术栈
- **Vue3**：前端框架，提供响应式用户体验
- **Element Plus**：UI 组件库，提升用户交互体验
- **腾讯云 COS**：存储静态资源
- **Nginx**：前端页面部署与优化

### 部署架构
- **Docker**：容器化部署，提升开发和运维效率
- **Nginx**：反向代理，解决跨域问题，并优化高并发处理
- **自动化脚本**：定期拉取更新并重新编译 Docker 镜像

## 功能模块

### 1. 管理模块
- 管理员可对用户、小镇、商家、文章进行增删查改
- 支持批量操作，提高管理效率

### 2. 用户登录
- 支持用户注册、登录、登出
- 采用 JWT 进行身份认证

### 3. 图片模块
- 采用腾讯云 COS 存储图片资源
- 减轻服务器压力，提高图片加载速度

## 部署指南

1. **克隆仓库**
   ```bash
   git clone https://github.com/limou3434/nfu-town.git
   cd nfu-town
   ```
2. **构建 Docker 镜像并运行**
   ```bash
   docker-compose up -d
   ```
3. **访问系统**
   - 前端地址：http://localhost
   - 后端 API：http://localhost:3000

## 贡献指南
欢迎对本项目提出 Issue 或 Pull Request，共同优化 NFU Town。

## 许可证
本项目遵循 MIT 许可证，详情请见 [LICENSE](./LICENSE)。