miaoguo_system_server

Koa用户管理API

这是一个基于Koa.js的简单用户管理API示例，使用MySQL作为数据库。

功能特点

• 基于Koa.js框架
• 使用ES模块语法
• MySQL数据库连接
• RESTful API设计
• 环境配置分离

安装

Node.js 版本要求

本项目需要 Node.js 24.1.0 版本。如果你使用 nvm，可以按照以下步骤设置：

# 安装所需的 Node.js 版本（如果尚未安装）
nvm install 24.1.0

# 切换到项目所需的 Node.js 版本
nvm use

如果你没有安装 nvm，可以从 Node.js 官网 下载并安装 24.1.0 版本。

项目安装

# 克隆仓库
git clone https://scoreline.kylx365.com/kylx365/miaoguo_system_server.git
cd miaoguo_system_server

# 确保使用正确的 Node.js 版本
nvm use

# 安装依赖
npm install

数据库设置

1. 确保MySQL服务已启动
2. 执行初始化SQL脚本:

mysql -u root -p < doc/init.sql

环境变量

可以通过环境变量自定义配置:

• NODE_ENV: 设置环境 (development 或 production)
• PORT: 服务器端口
• DB_HOST: 数据库主机
• DB_USER: 数据库用户名
• DB_PASSWORD: 数据库密码
• DB_NAME: 数据库名称

运行

# 开发环境
npm run dev

# 生产环境
npm run start

API端点

示例请求

查看API是否能运行

curl http://localhost:3000/api/Ping