nArchitecture.Gen 项目安装与配置指南

1. 项目基础介绍

nArchitecture.Gen 是一个基于 Clean Architecture 原则构建的项目代码生成工具。它旨在帮助开发者快速搭建具有良好架构的 .NET 项目，内嵌了 CQRS、高级仓库模式、动态查询、JWT 和 OTP 认证机制、Google 和 Microsoft 身份验证集成、基于角色的管理系统、Redis 分布式缓存、Serilog 日志功能、Elastic Search 功能以及丰富的代码生成器。

该项目主要使用 C# 编程语言。

2. 项目使用的关键技术和框架

• .NET: 项目的基础框架，用于构建后端服务。
• Clean Architecture: 一种软件设计哲学，旨在分离应用程序的不同层面，以提高可维护性和可测试性。
• CQRS: Command Query Responsibility Segregation，一种设计模式，用于分离读写操作。
• JWT: JSON Web Tokens，用于身份验证和信息交换。
• OTP: One-Time Password，一次性密码，用于增加安全性。
• Redis: 一个开源的 in-memory 数据结构存储系统，用作数据库、缓存和消息代理。
• Serilog: 一个强大的日志库，支持结构化日志记录。
• Elasticsearch: 一个基于 Lucene 的搜索引擎，用于全文搜索。

3. 项目安装和配置的准备工作与详细步骤

准备工作

在开始安装之前，请确保您的开发环境满足以下要求：

• 操作系统: 支持 .NET 8 的 Windows、Linux 或 macOS。
• .NET SDK: 安装最新版本的 .NET SDK，可以从 官方.NET网站 下载。

安装步骤

1. 克隆项目到本地

   打开命令行窗口，运行以下命令来克隆项目：

   git clone https://github.com/kodlamaio-projects/nArchitecture.Gen.git
   cd nArchitecture.Gen
   

2. 安装全局工具（可选）

   如果您希望全局使用 nArchGen 工具，请在命令行中运行以下命令：

   dotnet tool install --global NArchitecture.Gen
   

   如果您只想在当前项目中使用，请执行以下步骤：

   • 创建 dotnet 工具清单：

     dotnet new tool-manifest
     

   • 在项目中安装工具：

     dotnet tool install NArchitecture.Gen
     

3. 使用 nArchGen 工具

   在项目解决方案目录中，运行以下命令来使用 nArchGen：

   nArchGen
   

   请按照命令行提示进行操作，以生成所需的项目代码。

通过以上步骤，您应该能够成功安装并配置 nArchitecture.Gen 项目。现在，您可以开始使用这个强大的代码生成工具来加速您的开发工作了。