# express-server

**Repository Path**: sk20020228/express-server

## Basic Information

- **Project Name**: express-server
- **Description**: express-server是个人手动搭建的项目，只要用于学习express编写后端服务。

大致功能：

- 连接数据库
- 生成接口文档
- token校验
- cors
- 错误日志
- 环境变量
- 静态文件
- 等等
- **Primary Language**: NodeJS
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-10
- **Last Updated**: 2025-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Nodejs

## README

# express-server

## 项目介绍

`express-server`是个人手动搭建的项目，只要用于学习express编写后端服务。

大致功能：

- 连接数据库
- 生成接口文档
- token校验
- cors
- 错误日志
- 环境变量
- 静态文件



## 项目编写记录

根目录下的Docs.md



## 下载项目

```
git clone https://gitee.com/sk20020228/express-server.git
```



## 安装依赖

> 如果安装依赖有误尝试切换版本，node版本为16.20.2，npm版本为7.24.2

```
npm install
```



## 安装工具

> 根据需要安装nodemon或者pm2

```
npm install nodemon -g
npm install pm2 -g
```



> 根据安装的工具修改package.json

```json
  "scripts": {
    "serve": "node app.js",
    "serve:dev": "cross-env NODE_ENV=development nodemon app.js",
    "serve:test": "cross-env NODE_ENV=test nodemon app.js",
    "serve:prod": "cross-env NODE_ENV=production nodemon app.js",
    "pm2": "pm2 start app.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
```



## 修改默认配置

> 修改.env.xxx中的变量

```
# 端口
PORT=3000
# 数据库地址
MYSQL_HOST=127.0.0.1
# 数据库用户名
MYSQL_NAME=root
# 数据库密码
MYSQL_PASSWORD=123456
# 数据库名
MYSQL_DATABASE=server
# jwt密钥
JWT_SECRET=xadmin
# 管理员密码
ADMIN_PASSWORD=123456
```



## 运行项目

> 根据自己修改的package.json运行

```
npm run serve
```

运行的地址在控制台打印

> 默认地址如下
>
> 项目地址：http://localhost:3000
>