AFFiNE 项目教程

AFFiNE 项目教程

AFFiNE AFFiNE 是一个开源、一体化的工作区和操作系统，适用于组装您的知识库等的所有构建块 - 维基、知识管理、演示和数字资产。它是 Notion 和 Miro 的更好替代品。 项目地址: https://gitcode.com/gh_mirrors/af/AFFiNE

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

AFFiNE 项目的目录结构如下：

AFFiNE/
├── .github/
├── .vscode/
├── apps/
│   ├── affine/
│   ├── docs/
│   └── web/
├── packages/
│   ├── blocksuite/
│   ├── jwst/
│   └── jwst-rpc/
├── scripts/
├── .editorconfig
├── .eslintrc.js
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录结构介绍

• .github/: 存放 GitHub 相关的配置文件，如 GitHub Actions 的工作流配置。
• .vscode/: 存放 Visual Studio Code 的配置文件，如代码格式化、调试配置等。
• apps/: 存放应用程序的代码，包括 affine/、docs/ 和 web/ 三个子目录。
  • affine/: 存放 AFFiNE 核心应用程序的代码。
  • docs/: 存放项目的文档文件。
  • web/: 存放 Web 相关的代码，如前端页面、API 接口等。
• packages/: 存放项目的各个包（package），包括 blocksuite/、jwst/ 和 jwst-rpc/。
  • blocksuite/: 存放与 Blocksuite 相关的代码。
  • jwst/: 存放与 JWST 相关的代码。
  • jwst-rpc/: 存放与 JWST RPC 相关的代码。
• scripts/: 存放项目的脚本文件，如构建脚本、测试脚本等。
• .editorconfig: 配置编辑器的格式化规则。
• .eslintrc.js: 配置 ESLint 的规则。
• .gitignore: 配置 Git 忽略的文件和目录。
• .prettierrc: 配置 Prettier 的格式化规则。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

AFFiNE 项目的启动文件主要位于 apps/affine/ 目录下。以下是主要的启动文件及其功能介绍：

• apps/affine/src/index.ts: 这是 AFFiNE 应用程序的主入口文件。它负责初始化应用程序、加载配置、启动服务等。
• apps/affine/src/server.ts: 这是服务器的启动文件，负责启动 HTTP 服务器、配置路由、处理请求等。
• apps/affine/src/client.ts: 这是客户端的启动文件，负责初始化前端应用、加载页面、处理用户交互等。

3. 项目的配置文件介绍

AFFiNE 项目的配置文件主要位于项目根目录下，以下是主要的配置文件及其功能介绍：

• .editorconfig: 配置编辑器的格式化规则，确保团队成员使用统一的代码风格。
• .eslintrc.js: 配置 ESLint 的规则，用于代码静态分析和代码质量检查。
• .gitignore: 配置 Git 忽略的文件和目录，避免将不必要的文件提交到版本控制系统中。
• .prettierrc: 配置 Prettier 的格式化规则，用于自动格式化代码。
• package.json: 项目的依赖管理文件，定义了项目的依赖包、脚本命令、版本信息等。
• tsconfig.json: TypeScript 的配置文件，定义了 TypeScript 编译器的选项和编译目标。

这些配置文件共同确保了项目的代码风格一致性、代码质量以及项目的正常运行。

AFFiNE AFFiNE 是一个开源、一体化的工作区和操作系统，适用于组装您的知识库等的所有构建块 - 维基、知识管理、演示和数字资产。它是 Notion 和 Miro 的更好替代品。 项目地址: https://gitcode.com/gh_mirrors/af/AFFiNE