# Blog-API

**Repository Path**: amoylel/blog-api

## Basic Information

- **Project Name**: Blog-API
- **Description**: 为博客站点（Blog-WEB）和博客管理后台（Blog-ADMIN）提供 API 接口服务
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2024-01-29
- **Last Updated**: 2024-01-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 博客 API

此项目是博客的 API 项目，为博客主站【Blog-WEB】和管理后台【Blog-ADMIN】提供 API 接口服务，基于 NestJs 框架开发，ORM 使用的 prisma 框架，数据库使用的 SQLite。

### 项目运行

1. 克隆项目到本地
2. 进入项目目录，安装项目依赖 `npm install`
3. 根据 schema.prisma 文件生成数据库 `npx prisma db push` ，数据库文件名的配置在 `.env` 文件内： `DATABASE_URL="file:./dev.db"`
4. 根据 seed.ts 生成初始化数据 `npx prisma db seed`
5. 执行 `npx prisma generate` 生成客户端数据模型
6. 运行项目 `npm run start`

### 控制器说明

1. 以 web- 开头的控制器是给博客主站【Blog-WEB】使用的，因此没有做 jwt token 验证；
2. 没有以 web- 开头的则是给管理后台【Blog-ADMIN】使用的，管理后台的每个接口都有做 jwt token 验证，所以请求管理后台的接口 API 之前必须先登录。


### 其他说明

1. `.env` 文件中的 `SALT` 是给登录账号的密码进行加盐加密使用的
2. `.env` 文件中的 `SECRET` 是 jwt 验证所用的密钥
3. `test-api` 是用来做 API 接口测试的，需要安装 `REST Client` 插件
4. 为了轻量，所以数据库采用的 SQLite，无需安装，直接通过上面的指令生成即可，管理工具可以使用插件 `SQLite` （小羽毛）