Sequel 项目使用教程

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

Sequel 项目的目录结构如下：

Sequel/
├── app/
├── public/
├── publish/
├── src/
├── .env.example
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── LICENSE
├── README.md
├── bun.lockb
├── components.json
├── favicon.ico
├── forge.config.js
├── package.json
├── tailwind.config.js
├── tsconfig.json
└── yarn.lock

目录结构介绍

• app/: 存放应用程序的主要代码文件。
• public/: 存放公共资源文件，如图片、样式表等。
• publish/: 存放发布相关的文件。
• src/: 存放源代码文件。
• .env.example: 环境变量配置文件示例。
• .eslintignore: ESLint 忽略文件配置。
• .eslintrc.js: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• bun.lockb: Bun 包管理器锁文件。
• components.json: 组件配置文件。
• favicon.ico: 网站图标文件。
• forge.config.js: Electron Forge 配置文件。
• package.json: 项目依赖和脚本配置文件。
• tailwind.config.js: Tailwind CSS 配置文件。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 包管理器锁文件。

2. 项目的启动文件介绍

Sequel 项目的启动文件主要包括以下几个部分：

2.1 开发服务器启动

在开发环境中，可以使用以下命令启动开发服务器：

bun run devstart

2.2 Electron 应用启动

如果需要启动 Electron 应用，可以使用以下命令：

bun run electron

2.3 选择 Chat 模型

在使用 Chat 模块之前，需要在设置中选择模型并保存 API 密钥。具体步骤如下：

1. 点击左上角的齿轮图标进入设置。
2. 选择模型并保存。

3. 项目的配置文件介绍

3.1 .env.example

这是一个环境变量配置文件示例，用于配置项目所需的环境变量。在实际使用中，需要将 .env.example 复制为 .env 并根据实际情况进行配置。

3.2 .eslintrc.js

ESLint 配置文件，用于定义代码风格和规则。

3.3 package.json

项目依赖和脚本配置文件，包含了项目的依赖包、启动脚本等信息。

3.4 tailwind.config.js

Tailwind CSS 配置文件，用于自定义 Tailwind CSS 的样式。

3.5 tsconfig.json

TypeScript 配置文件，用于配置 TypeScript 编译选项。

3.6 forge.config.js

Electron Forge 配置文件，用于配置 Electron 应用的构建和打包选项。

通过以上配置文件，可以对 Sequel 项目进行详细的配置和定制。