Next Hexagonal Starter 使用教程

1. 项目介绍

Next Hexagonal Starter 是一个基于 Next.js 和 Hexagonal Architecture 的前端项目结构模板。它使用了 TypeScript 作为编程语言，并且整合了多种流行的工具和库，例如 TailwindCSS、DaisyUI、Cypress、Jest 等，以便于开发者构建高质量的前端应用程序。项目的架构遵循“尖叫架构”方法，通过模块化的方式组织代码，实现领域逻辑、应用逻辑和基础设施之间的清晰分离。

2. 项目快速启动

环境准备

在开始之前，请确保您的系统中已安装以下依赖：

• Node.js
• npm 或 yarn

克隆项目

首先，克隆项目到本地：

git clone https://github.com/carlosazaustre/next-hexagonal-starter.git
cd next-hexagonal-starter

安装依赖

接着，安装项目依赖：

npm install

或者，如果您使用 yarn：

yarn install

运行项目

最后，启动开发服务器：

npm run dev

或者，使用 yarn：

yarn dev

现在，您可以在浏览器中访问 http://localhost:3000 来查看项目。

3. 应用案例和最佳实践

模块化架构

在 Next Hexagonal Starter 中，每个模块都遵循自己的领域（domain）、应用（application）和基础设施（infra）层次结构。这种组织方式有助于保持代码的清晰和可维护性。

例如，假设您正在创建一个博客模块，您的目录结构可能如下所示：

src/
└── modules/
    └── blog/
        ├── domain/
        │   └── Post.ts
        ├── application/
        │   ├── get/
        │   │   └── getPostById.ts
        │   └── create/
        │       └── createPost.ts
        └── infra/
            └── ApiPostRepository.ts

代码风格和格式化

项目使用 ESLint 和 Prettier 来确保代码风格的一致性和格式化。通过 Husky 和 Commitlint，您可以保证在代码提交前自动执行这些检查。

4. 典型生态项目

Next Hexagonal Starter 可以作为多种类型前端应用的基础，包括但不限于：

• 博客平台
• 内容管理系统
• 社交媒体应用
• 电子商务网站

项目通过提供清晰的结构和最佳实践，帮助开发者快速搭建可扩展和可维护的前端应用。