# material_egg_server

**Repository Path**: pezihan/material_egg_server

## Basic Information

- **Project Name**: material_egg_server
- **Description**: egg+typescript
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-02-16
- **Last Updated**: 2023-07-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# material_egg_server

### 介绍

### material_web客户端 与 material_admin_web管理端服务器 API 

**API 接口文档：已部署至本项目**根节点  

`material_admin_web管理前端已打包成静态资源放在此项目下、:5001/index.html可以访问后台；api接口默认端口：5001`

**管理系统默认账户密码：admin  密码：123456**

### 项目环境

- 本地依赖环境

 Node.js + MySQL8 + ffmpeg + minio

- 创建数据库（数据库需要8.0以上）
  - 下载地址：https://dev.mysql.com/downloads/installer

  数据库文件在：db --> material_v2.sql

  创建数据库 material_v2，运行material_v2.sql  SQL 语句导入数据库

  `注：创建数据库 material_v2 选择字符集utf8mb4 `

  **​ 数据库默认连接名：root   密码： 123456**

- 准备ffmpeg 工具（用来给上传的视频作品截取封面图）

  下载地址： http://www.ffmpeg.org/download.html

- 准备minio

  - 下载地址： https://www.minio.org.cn/download.shtml

  - 运行：

    ```
    minio server 硬盘存储位置 --address=:9000 --console-address=:9100
    
    address: 接口地址
    console-address： 控制台地址
    ```

  - 进入9100管理端，创建一个存储桶，名字叫 resource，**创建成功将此存储桶访问权限改为公开。**

- 准备项目
  - 项目配置文件在 /config/文件下
  - config.default.ts为开发环境配置，config.prod.ts为正式环境配置
- 配置文件说明
  - 更改配置文件的 config.sequelize（数据库）、config.minioKey（minio存储）、config.emailConfig（邮箱）、config.MINIO_URL（minio文件访问地址），其他的配置尽量不要更改。

# 运行

### 开发环境

```bash
$ npm i
$ npm run dev
$ open http://localhost:5001/
```

Don't tsc compile at development mode, if you had run `tsc` then you need to `npm run clean` before `npm run dev`.

### 正式环境（部署）

```bash
$ npm run tsc
$ npm run start
```

注：项目运行后，进入后台添加一些素材后再调用前端接口

### Npm Scripts

- Use `npm run lint` to check code style
- Use `npm test` to run unit test
- se `npm run clean` to clean compiled js at development mode once

### Requirement

- Node.js 8.x
- Typescript 2.8+