Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kangood/prune-api

Prune Admin 的后端数据服务,基于 NestJS、TypeScript、TypeORM、MySQL 构建,实现了 JWT 认证、菜单管理、RBAC 权限控制等核心功能
https://github.com/kangood/prune-api

fastify-multer jwt-auth mysql nestjs typeorm typescript

Last synced: about 2 months ago
JSON representation

Prune Admin 的后端数据服务,基于 NestJS、TypeScript、TypeORM、MySQL 构建,实现了 JWT 认证、菜单管理、RBAC 权限控制等核心功能

Awesome Lists containing this project

README

        






Prune Api


## 简介

Prune Api 是现代化风格的快速开发平台 [Prune Admin](https://github.com/KangodYan/prune-admin) 的后端数据服务,基于 NestJS、TypeScript、TypeORM、MySQL 构建。

## 快速开始

### 获取项目代码

```bash
git clone https://github.com/KangodYan/prune-api.git
```

### 导入数据库文件

- 在 MySQL8 数据库中新建数据库,命名 `prune`
- 找到项目根目录下的 `prune.sql` 文件,导入到 `prune` 数据库中
- 在数据库配置文件中去掉 sql_mode 配置项的 `ONLY_FULL_GROUP_BY` 选项,然后重启服务

### 安装依赖

在项目根目录下运行以下命令安装项目依赖:

```bash
pnpm install
```
### 添加配置

在根目录下创建 `.env.dev` 文件,手动复制 `.env.example` 文件内容到 `.env.dev`,并填写对应相应配置

### 启动开发服务器

运行以下命令以启动开发服务器:

```bash
pnpm start:dev
```

访问 [http://localhost:7441](http://localhost:7441) 查看您的应用程序。

### 构建生产版本

创建 `.env.prod` 文件并填写好配置,运行以下命令以构建生产版本:

```bash
pnpm build
```

### 在生产环境启动服务

```bash
pnpm start:prod
```