# pure-node-serve

**Repository Path**: todpole/pure-node-serve

## Basic Information

- **Project Name**: pure-node-serve
- **Description**: 集成 `express` `sequelize` `swagger-ui` 框架 api 模板 一个 "开箱即用" node接口服务模板去快速开始你的项目！
适配于 `vue3-admin`
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://pure.kd-yun.top/
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-12-13
- **Last Updated**: 2025-05-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# pure-node-serve

## 项目介绍

- 使用浏览器指纹技术，实现单设备单用户登录
- 使用 Redis 实现异步任务队列
- 实现 腾讯云短信服务
- 实现 邮件发送服务
- 本项目搭配前端项目👉[vue3-admin](https://gitee.com/todpole/vue3-admin.git)

## 预览

[点我查看预览](https://pure.kd-yun.top)

- 账号：admin
- 密码：admin123

## 开发环境

- Node.js 版本 >=18.x (推荐：18.19.1)
- pnpm 版本 >=8.x (推荐：9.0)

`推荐版本为本人的开发环境，请使用对应版本，否则可能出现未知问题。如果出现问题，请尝试切换到推荐版本。)`

## 开发工具

```shell
1. node.js 环境
2. Express.js 框架
3. IDEA / WebStorm / VS Code 开发工具
4. Navicat 可视化数据库
5. apiPost / postman 接口调试工具
```

## 安装使用

### 拉取代码

#### 从 `GitHub` 上拉取

```bash
git clone https://github.com/autchan-ak/pure-node-serve.git
```

#### 从 `Gitee` 上拉取

```bash
git clone https://gitee.com/todpole/pure-node-serve.git
```

### 安装依赖

```bash
  cd pure-node-serve

  pnpm install
```

## 配置基本信息 `文件 config/db.js`

- mysql
- redis

## 启动服务

```bash
pnpm serve
```

## 文件目录说明

```text
filetree 

├── README.md
└──/config/                   配置文件
│  ├── db.js                  - 数据库配置文件
│  ├── ...
│  │
├── /controllers/             控制层 处理具体业务
│  ├── ...
│  │
├── /dao/                     数据库查询方法
│  └── DAO                    - 公共数据库查询方法
│  │
├── /locales/                 国际化配置文件
│  ├── ...
│  │
├── logs/                     系统日志记录
│  ├── access/                - 请求日志文件
│  │  │  ├── ...
│  ├── danger/                - 错误日志文件
│  │  │  ├── ...
│  ├── info/                  - 一般日志文件
│  │  │  ├── ...
│  ├── warning/               - 警告日志文件
│  │  │  ├── ...
│  ├── operation_logs_**.log  - 操作日志记录文件
│  │
├── /models/                  数据模型和定义
│  ├── index.js               sequelize 实例 和 模型主入口
│  ├── ...
│  │
├── public/                   静态资源
│  ├── ...
│  │
├── /routes/                  接口路由文件夹
│  ├── /api/                  /api前缀的路由文件夹
│  │  ├── /private/           存放需要权限token的接口文件夹
│  │  │  ├── ...    
│  │  │  │ 
│  │  └── /public/            存放无需token校验的接口
│  │  │  ├── ...
│  │  │  │ 
├── /sql/                     sql 源数据
│  ├── ...
│  │
├── /uploads_files/           上传存放的文件夹
│  │  │ 
├── /utils/                   工具方法文件夹
│  │  ├── _logger.js          日志记录配置文件
│  │  ├── _logs_worker        操作日志定时记录配置
│  │  ├── _resextra.js        统一响应格式
│  │  ├── _schedule.js        定时任务配置文件
│  |  ├── _swagger.js         swagger配置文件夹
│  |  ├── index.js            方法库入口文件
│  │  └── ...
├── .env                      环境配置文件
├── app.js                    入口文件
```

## 最后

- 🌟 如果喜欢一定要 star哈!!!（谢谢!!）
- ❓ 如果有意见和问题 请在 lssues提出，我看到后会解答。
- 📢 承接Vue、React、小程序等项目开发。有需求可滴滴哦
- 🚀 可添加作者 绿泡泡 `tadpole_01`

<img src="public/绿泡泡.jpg" alt="公众号" width="60%" >