开源项目 `clean-ts-api` 使用教程

开源项目 clean-ts-api 使用教程

clean-ts-apiAPI em NodeJs usando Typescript, TDD, Clean Architecture, Design Patterns e SOLID principles项目地址:https://gitcode.com/gh_mirrors/cl/clean-ts-api

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

clean-ts-api/
├── src/
│   ├── main/
│   │   ├── adapters/
│   │   ├── config/
│   │   ├── domain/
│   │   ├── infrastructure/
│   │   ├── presentation/
│   │   └── server.ts
│   └── tests/
│       ├── integration/
│       └── unit/
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

目录结构说明

• src/: 源代码目录。
  • main/: 主应用程序代码。
    • adapters/: 适配器层，处理外部接口和内部逻辑的适配。
    • config/: 配置文件，包括数据库、日志等配置。
    • domain/: 领域层，包含业务逻辑和实体。
    • infrastructure/: 基础设施层，处理数据库、外部服务等。
    • presentation/: 表示层，处理HTTP请求和响应。
    • server.ts: 应用程序的入口文件。
  • tests/: 测试代码目录。
    • integration/: 集成测试。
    • unit/: 单元测试。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

src/main/server.ts

server.ts 是项目的启动文件，负责初始化应用程序并启动服务器。以下是该文件的主要内容：

import { setupApp } from './config/app'

const start = async () => {
  const app = await setupApp()
  app.listen(process.env.PORT || 5000, () => {
    console.log(`Server running on port ${process.env.PORT || 5000}`)
  })
}

start()

启动文件说明

• setupApp 函数: 初始化应用程序，包括设置路由、中间件和依赖注入。
• app.listen 方法: 启动服务器并监听指定端口。

3. 项目的配置文件介绍

.env

.env 文件用于存储环境变量，例如数据库连接字符串、端口号等。以下是一个示例：

PORT=5000
DATABASE_URL=mongodb://localhost:27017/clean-ts-api

tsconfig.json

tsconfig.json 文件用于配置TypeScript编译选项。以下是该文件的主要内容：

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*"]
}

配置文件说明

• compilerOptions: TypeScript编译选项。
  • target: 指定编译目标版本。
  • module: 指定模块系统。
  • outDir: 指定输出目录。
  • rootDir: 指定源代码目录。
  • strict: 启用严格模式。
  • esModuleInterop: 启用ES模块互操作。
  • skipLibCheck: 跳过库文件类型检查。
• include: 指定包含的文件和目录。

clean-ts-apiAPI em NodeJs usando Typescript, TDD, Clean Architecture, Design Patterns e SOLID principles项目地址:https://gitcode.com/gh_mirrors/cl/clean-ts-api