清洁架构与TypeScript实践项目教程

清洁架构与TypeScript实践项目教程

clean-architecture-with-typescript Sample Code for Clean Architecture using TypeScript 项目地址: https://gitcode.com/gh_mirrors/cl/clean-architecture-with-typescript

1. 项目的目录结构及介绍

本项目采用清洁架构（Clean Architecture）设计模式，结合TypeScript语言，实现了Monorepo结构。项目的目录结构如下：

/packages
├─ domains
│  └─ src
│     ├─ aggregates
│     ├─ entities
│     ├─ useCases
│     ├─ vos
│     ├─ repositories
│     │  └─ interface
│     └─ dtos
│        └─ interface
├─ adapters
│  └─ src
│     ├─ presenters
│     ├─ repositories
│     ├─ dtos
│     └─ infrastructures
│        └─ interface
├─ client-a(built with React)
│  └─ src
│     ├─ di
│     └─ ...
└─ client-b(built with Next.js)
└─ src
├─ di
└─ ...

• domains：领域模型层，包含实体（Entities）、聚合根（Aggregates）、应用用例（Use Cases）、值对象（Value Objects）以及存储库接口（Repositories interface）。
• adapters：适配器层，包含表示器（Presenters）、存储库实现（Repositories）、数据传输对象（Data Transfer Objects）以及基础设施接口（Infrastructures interface）。
• client-a 和 client-b：客户端服务层，分别基于React和Next.js构建，实现用户界面。

2. 项目的启动文件介绍

项目的启动文件通常位于客户端服务的根目录下，例如对于基于React的client-a，其启动文件为src/index.tsx。以下是一个简单的启动文件示例：

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>,
  document.getElementById('root')
);

此文件负责将React应用程序的根组件App渲染到DOM中。

3. 项目的配置文件介绍

本项目使用了TypeScript、ESLint和Jest等工具，相应的配置文件如下：

• tsconfig.json：TypeScript配置文件，定义了项目的编译选项和包含/排除的文件。
• .eslintrc.js：ESLint配置文件，用于定义代码质量和风格规则。
• jest.config.js：Jest配置文件，用于设置单元测试的相关配置。

这些配置文件确保了代码的规范性和一致性，有助于项目的维护和开发。

clean-architecture-with-typescript Sample Code for Clean Architecture using TypeScript 项目地址: https://gitcode.com/gh_mirrors/cl/clean-architecture-with-typescript