ADAMANT Decentralized Messenger 项目教程

1. 项目目录结构及介绍

ADAMANT Decentralized Messenger 项目的目录结构如下：

adamant-im/
├── commitlint/
│   └── config.js
├── cypress/
│   └── json
├── deploy/
│   └── sh
├── electron-builder/
│   ├── env.example
│   └── yml
├── electron-vite/
│   └── config.ts
├── index.html
├── openapitools/
│   └── json
├── package-lock.json
├── package.json
├── stats.json
├── tsconfig/
│   ├── json
│   └── node.json
├── vite-base/
│   └── config.ts
├── vite-pwa/
│   └── config.ts
└── vitest/
    └── config.ts

目录结构介绍

• commitlint/: 包含与 Git 提交消息格式相关的配置文件。
• cypress/: 包含 Cypress 测试框架的配置文件。
• deploy/: 包含部署脚本。
• electron-builder/: 包含 Electron 构建工具的配置文件。
• electron-vite/: 包含 Electron 和 Vite 集成的配置文件。
• index.html: 项目的入口 HTML 文件。
• openapitools/: 包含 OpenAPI 工具的配置文件。
• package-lock.json: 锁定项目依赖版本的文件。
• package.json: 项目的依赖和脚本配置文件。
• stats.json: 可能包含项目构建统计信息。
• tsconfig/: 包含 TypeScript 配置文件。
• vite-base/: 包含 Vite 基础配置文件。
• vite-pwa/: 包含 Vite PWA（渐进式 Web 应用）配置文件。
• vitest/: 包含 Vitest 测试框架的配置文件。

2. 项目启动文件介绍

项目的启动文件主要是 index.html 和 package.json 中的脚本配置。

index.html

这是项目的入口 HTML 文件，负责加载和启动应用的前端部分。

package.json

在 package.json 中，启动脚本通常定义在 scripts 部分。例如：

{
  "scripts": {
    "start": "vite",
    "build": "vite build",
    "test": "vitest"
  }
}

• start: 启动开发服务器。
• build: 构建生产版本。
• test: 运行测试。

3. 项目配置文件介绍

项目的配置文件主要分布在各个子目录中，以下是一些关键配置文件的介绍：

commitlint/config.js

用于配置 Git 提交消息的格式规范。

cypress/json

Cypress 测试框架的配置文件，定义测试环境和行为。

deploy/sh

部署脚本，用于自动化部署流程。

electron-builder/env.example

Electron 构建工具的环境变量配置示例。

electron-builder/yml

Electron 构建工具的配置文件，定义构建流程和输出。

electron-vite/config.ts

Electron 和 Vite 集成的配置文件，定义开发和构建流程。

tsconfig/json

TypeScript 编译器的配置文件，定义编译选项和目标环境。

vite-base/config.ts

Vite 基础配置文件，定义开发服务器和构建选项。

vite-pwa/config.ts

Vite PWA 配置文件，定义 PWA 相关的行为和设置。

vitest/config.ts

Vitest 测试框架的配置文件，定义测试环境和行为。

通过以上配置文件，可以灵活地调整项目的开发、测试和部署流程。