# node-api

**Repository Path**: ifercarly/node-api

## Basic Information

- **Project Name**: node-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-30
- **Last Updated**: 2024-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Node API

项目使用了 Node.js + Express + MySQL + Sequelize ORM 开发。

## 配置环境变量

将`.env.example`文件拷贝为`.env`文件，并修改配置。

```txt
NODE_ENV=development
PORT=3000
SECRET=你的秘钥
```

- `NODE_ENV`配置为开发环境，如部署在生产环境可改为`production`。
- `PORT`配置为服务端口
- `SECRET`配置为秘钥。

## 生成秘钥

在命令行中运行 

```shell
node
```

进入交互模式后，运行

```shell
const crypto = require('crypto');
console.log(crypto.randomBytes(32).toString('hex'));
```

复制得到的秘钥，并填写到`.env`文件中的`SECRET`配置。

> PS：可以使用 `ctrl + c` 退出交互模式。

## 配置数据库

项目使用 Docker 容器运行 MySQL 数据库。安装好 Docker 后，可直接启动 MySQL。

```shell
docker-compose up -d
```

如需使用自行安装的 MySQL，需要修改`config/config.js`文件中的数据库用户名与密码。

```json
{
  "development": {
    "username": "您的数据库用户名",
    "password": "您的数据库密码"
  }
}
```

## 安装与运行

```shell
# 安装项目依赖包
npm i

# 创建数据库。如创建失败，可以手动建库。
npx sequelize-cli db:create --charset utf8mb4 --collate utf8mb4_general_ci

# 运行迁移，自动建表。
npx sequelize-cli db:migrate

# 运行种子，填充初始数据。
npx sequelize-cli db:seed:all

# 启动服务
npm start
```

访问地址：[http://localhost:3000](http://localhost:3000)，详情请看接口文档。

## 初始管理员账号

```txt
账号：admin
密码: 123123
```