NestJS API Boilerplate JWT 常见问题解决方案

NestJS API Boilerplate JWT 常见问题解决方案

nestjs-api-boilerplate-jwt An API Boilerplate to create a ready-to-use REST API in seconds with NestJS v10.x + TypeORM and JWT Auth 😻 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-api-boilerplate-jwt

1. 项目基础介绍和主要编程语言

本项目是基于 NestJS 框架的 REST API 开发模板，集成了 JWT 认证机制。它可以帮助开发者快速搭建一个具备身份验证功能的 RESTful API 服务。主要编程语言是 TypeScript，这也是 NestJS 官方推荐的编程语言。

2. 新手常见问题及解决步骤

问题一：如何安装和启动项目

问题描述： 新手在获取项目后，不知道如何安装依赖并启动项目。

解决步骤：

1. 克隆项目到本地：

   git clone https://github.com/Tony133/nestjs-api-boilerplate-jwt.git
   

2. 进入项目目录：

   cd nestjs-api-boilerplate-jwt
   

3. 安装项目依赖：

   pnpm install
   

4. 复制环境配置文件（根据实际情况修改）：

   cp env/example env
   

5. 启动项目（开发模式）：

   pnpm start:dev
   

问题二：如何配置数据库连接

问题描述： 项目默认使用的是 MySQL 数据库，新手不知道如何配置数据库连接。

解决步骤：

1. 打开 .env 文件，找到与数据库相关的配置项。
2. 修改数据库配置如下：

   TYPEORM_CONNECTION=postgres
   TYPEORM_HOST=localhost
   TYPEORM_PORT=5432
   TYPEORM_USERNAME=your_username
   TYPEORM_PASSWORD=your_password
   TYPEORM_DATABASE=your_database
   TYPEORM_AUTO_SCHEMA_SYNC=true
   

3. 保存文件后，重启项目使配置生效。

问题三：如何运行数据库迁移

问题描述： 新手不知道如何运行数据库迁移来同步数据库结构。

解决步骤：

1. 运行迁移命令，同步数据库结构：

   pnpm run typeorm migration:run
   

2. 如果需要撤销迁移，可以使用以下命令：

   pnpm run typeorm migration:revert
   

3. 确保在运行迁移命令之前，数据库配置正确无误。

通过以上步骤，新手可以顺利地开始使用 NestJS API Boilerplate JWT 项目，并解决在初始使用过程中可能遇到的常见问题。

nestjs-api-boilerplate-jwt An API Boilerplate to create a ready-to-use REST API in seconds with NestJS v10.x + TypeORM and JWT Auth 😻 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-api-boilerplate-jwt