# magic-express

**Repository Path**: song-xinyuan/magic-node

## Basic Information

- **Project Name**: magic-express
- **Description**: apifox + express实现 基础业务 接口
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-02
- **Last Updated**: 2025-02-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# magic-node
魔法node
## 简要概述
```
前期准备
基于 express + mysql2 + Navicat + mysql + nvm + node(v16.17.0)

sudo vim ~/.zshrc i 编辑 

环境变量：PATH=$PATH:/usr/local/mysql/bin  ESC :wq 保存退出

mysql -uroot -p  回车输入密码

SHOW DATABASES 查看数据库

```

## 主要结构
```
├── app.js
├── connection
│   └── db.config.js
├── package.json
├── router
│   └── userRouter.js
├── service
│   └── userService.js
├── controller
│   └── userController.js
└── sql
│   └── user.js
└── middleware
│   └── jwt
│   └── verification
│   └── wsChat
└── eslint.config.mjs
└── .gitignore
└── changelog.config.js
└── README.md
```

## 1，项目初始化

```
npm init -y
```

## 2，安装依赖

```
npm install express mysql2 bcrypt
```


## 分支管理
```
staging: 开发分支

master: 线上分支

原则上每次新功能都从master分支上 checkout 出来一个分支，开发完成之后，合并到staging测试通过后，再合并到master分支
```

## 3，功能实现
```
每次新增一个功能在下面列出

1. 模块化开发
2. 用户注册
```

## 开发和调试
```
npm run dev
```

## 4，编译和打包
```
npm run build
```

## 5，部署



### 5.1， 测试环境部署
```
1. 修改配置文件
2. npm run build
3. 将dist目录下的文件拷贝到服务器
4. 在服务器上运行 npm install
5. npm run dev
```

### 5.2，线上环境部署



## 6，常见问题说明：