Cherry Studio开源项目教程

Cherry Studio开源项目教程

cherry-studio 🍒 Cherry Studio is a desktop client that supports for multiple LLM providers. Support deepseek-r1 项目地址: https://gitcode.com/gh_mirrors/ch/cherry-studio

1. 项目目录结构及介绍

Cherry Studio项目的目录结构如下：

cherry-studio/
├── .github/
├── .husky/
├── .vscode/
├── .yarn/
├── build/
├── docs/
├── packages/
├── resources/
├── scripts/
├── src/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc
├── .yarnrc.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── dev-app-update.yml
├── electron-builder.yml
├── electron.vite.config.ts
├── eslint.config.mjs
├── package.json
├── tsconfig.json
├── tsconfig.node.json
├── tsconfig.web.json
└── yarn.lock

以下是各个目录和文件的简要说明：

• .github/: 包含GitHub的配置文件，如 ISSUE_TEMPLATE。
• .husky/: 包含 husky 配置，用于在提交代码前执行预提交钩子。
• .vscode/: 包含 Visual Studio Code 的项目配置。
• .yarn/: 包含 yarn 的缓存和配置文件。
• build/: 构建脚本和中间文件。
• docs/: 项目文档。
• packages/: 项目中的包文件。
• resources/: 资源文件，如图片、字体等。
• scripts/: 项目脚本，用于执行特定的任务。
• src/: 源代码目录，包含项目的核心代码。
• .editorconfig: 编辑器配置文件，用于统一不同开发者的代码风格。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc: Prettier 配置文件。
• .yarnrc.yml: yarn 配置文件。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目自述文件。
• dev-app-update.yml: 开发应用更新配置。
• electron-builder.yml: Electron 打包配置。
• electron.vite.config.ts: Electron Vite 配置。
• eslint.config.mjs: ESLint 配置。
• package.json: npm 包配置文件。
• tsconfig.json: TypeScript 配置文件。
• tsconfig.node.json: TypeScript 节点配置文件。
• tsconfig.web.json: TypeScript Web 配置文件。
• yarn.lock: yarn 锁文件。

2. 项目的启动文件介绍

项目的启动文件通常是 package.json 文件中的脚本。以下是 package.json 中的启动脚本示例：

{
  "scripts": {
    "start": "vite",
    "build": "vite build",
    "serve": "vite preview"
  }
}

• "start": 使用 Vite 运行开发服务器。
• "build": 使用 Vite 构建生产版本的项目。
• "serve": 使用 Vite 预览构建的生产版本。

在命令行中运行 yarn start 将启动开发服务器。

3. 项目的配置文件介绍

项目的配置文件主要包括 .editorconfig、.prettierrc、eslintrc.config.mjs 和 package.json 中的相关配置部分。

• .editorconfig: 用于定义代码风格，确保不同开发者的代码风格一致。
• .prettierrc: 用于配置 Prettier 的代码格式化规则。
• eslintrc.config.mjs: 用于配置 ESLint 的代码检查规则。
• package.json 中的配置部分包括项目的名称、版本、描述、依赖、脚本等。

这些配置文件确保代码的一致性和质量，有助于维护项目的可读性和可维护性。

cherry-studio 🍒 Cherry Studio is a desktop client that supports for multiple LLM providers. Support deepseek-r1 项目地址: https://gitcode.com/gh_mirrors/ch/cherry-studio