开源项目安装与配置指南

开源项目安装与配置指南

truthy Open source headless CMS API written using NestJS, that has pre built modules like User Management, Role Management, Permission Management, Email Module, Account Settings, OTP, Throttling, RBAC support, Localization, and many more. 项目地址: https://gitcode.com/gh_mirrors/tr/truthy

1. 项目基础介绍

Truthy CMS 是一个开源的后端API，采用 NestJS 框架开发。该项目旨在帮助开发者快速搭建基础的CMS（内容管理系统）功能，包括用户管理、角色管理、权限管理、邮件模块、账户设置、OTP（一次性密码）、RBAC支持（基于角色的访问控制）以及本地化等。Truthy CMS 的目标是通过提供这些基础模块，节省开发者在创建标准CMS时的时间，让他们可以专注于核心功能的开发。

主要的编程语言：

• NodeJS
• TypeScript

2. 关键技术和框架

• NestJS: 一个基于Node.js和TypeScript的渐进式框架，用于构建高效、可靠的服务端应用程序。
• TypeORM: 一个基于TypeScript的ORM（对象关系映射），可以与 TypeScript 和 JavaScript (ES5,ES6,ES7,ES8) 一起使用。
• JWT (JSON Web Tokens): 用于用户认证和授权。
• Redis: 作为内存数据结构存储，用于缓存、消息队列等。
• Swagger: 用于创建API文档和测试API端点。

3. 安装和配置准备工作

准备工作

• 确保安装了Node.js和npm（Node.js的包管理器）。
• 安装了PostgreSQL数据库和Redis服务器。
• 准备好代码编辑器或IDE。

安装步骤

1. 克隆项目到本地

   git clone https://github.com/gobeam/truthy.git
   

2. 进入项目目录

   cd truthy
   

3. 安装项目依赖

   npm install
   

4. 配置数据库和Redis

   • 修改项目根目录下 config 文件夹中的 development.yml 文件，配置数据库和Redis的连接信息。
   • 确保 .env 文件存在并包含了正确的环境变量。

5. 运行迁移脚本，创建数据库表结构

   npx typeorm migration:run
   

6. 运行种子脚本，填充初始数据（如果需要）

   npx typeorm seed:run
   

7. 启动项目

   npm run start
   

8. 访问 Swagger 文档（默认端口7777）

   http://localhost:7777/api-docs
   

以上就是Truthy CMS的详细安装和配置指南，按照以上步骤操作，即可成功搭建该项目。

truthy Open source headless CMS API written using NestJS, that has pre built modules like User Management, Role Management, Permission Management, Email Module, Account Settings, OTP, Throttling, RBAC support, Localization, and many more. 项目地址: https://gitcode.com/gh_mirrors/tr/truthy