# coreShopNodeJS

**Repository Path**: li-yanwen/core-shop-node-js

## Basic Information

- **Project Name**: coreShopNodeJS
- **Description**: 本项目是NodeJS入门学习项目，主要包含NodeJS基础、NodeJS Web开发、NodeJS高级技术、NodeJS项目实战等学习内容。
- **Primary Language**: NodeJS
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-02-17
- **Last Updated**: 2025-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 1. 项目介绍
- 项目名称：coreShopNodeJS
- 项目描述：本项目是NodeJS入门学习项目，主要包含NodeJS基础、NodeJS Web开发、NodeJS高级技术、NodeJS项目实战等学习内容。
- 项目地址：https://gitee.com/li-yanwen/core-shop-node-js
- 项目文档：https://gitee.com/li-yanwen/core-shop-node-js/blob/master/Readme.md

## 2. 项目结构
```
coreShopNodeJS/
│
├── config/
│   └── db.js          # 数据库连接配置
│
├── controllers/
│   ├── userController.js      # 用户管理控制器
│   ├── authController.js      # 登录与权限管理控制器
│   ├── menuController.js      # 菜单管理控制器
│   └── brandController.js     # 品牌管理控制器
│
├── models/
│   ├── userModel.js           # 用户模型
│   ├── menuModel.js           # 菜单模型
│   └── brandModel.js          # 品牌模型
│
├── routes/
│   ├── userRoutes.js          # 用户管理路由
│   ├── authRoutes.js          # 登录与权限管理路由
│   ├── menuRoutes.js          # 菜单管理路由
│   └── brandRoutes.js         # 品牌管理路由
│
├── middlewares/
│   └── authMiddleware.js      # 权限验证中间件
│
├── utils/
│   └── jwtUtils.js            # JWT 工具函数
│
├── app.js                     # 应用入口文件
│
└── package.json               # 项目依赖
```

## 3. 项目部署
- git项目克隆
```
git clone https://gitee.com/li-yanwen/core-shop-node-js.git
# 进入项目目录
cd coreShopNodeJS
```
- 本地环境配置(根目录下新建.env文件)
```
# .env
DB_HOST = "localhost"
DB_PORT = "3306"
DB_USER = "root"
DB_PASSWORD = "123456"
DB_NAME = "coreshop"
JWT_SECRET = "jwt_secret"
```
- 导入数据库
```
# Mysql数据库版本 5.7.38
mysql -u root -p < ./config/coreshop.sql
```

## 4. 项目运行
- 安装依赖
```
npm install
```
- 启动项目
```
npm start
npm run dev
```

## 5. 工具函数
- 统一返回数据格式
```
sendResponse(res, { data: mockData });

sendResponse(res, { 
  code: 404, 
  message: 'User not found',
  data: null 
});
```

## 6. api文档
- 后台登录与权限管理
```
# 用户登录
POST /admin/acl/index/login
# 用户登出
POST /admin/acl/index/logout
# 获取用户信息
GET /admin/acl/index/info
# 获取用户菜单
GET /admin/acl/index/menu
```
- 用户管理
```
# 获取用户列表
GET /admin/acl/user/
# 创建用户
POST /admin/acl/user/save
```

## 7. 权限说明
- 菜单权限说明
```
权限名称：   权限管理
权限代码：   Acl

权限名称：   用户管理
权限代码：   User

权限名称：   角色管理
权限代码：   Role

权限名称：   菜单管理
权限代码：   Menu
```