On-Device Transcription 项目使用教程

1. 项目目录结构及介绍

On-Device Transcription 的目录结构如下：

on-device-transcription/
├── src/                       # 源代码目录
│   ├── static/                # 静态文件目录
│   ├── .gitignore             # Git 忽略文件
│   ├── .npmrc                 # npm 配置文件
│   ├── LICENSE.md             # 许可证文件
│   ├── README.md              # 项目说明文件
│   ├── build.config.json      # 构建配置文件
│   ├── package-lock.json      # 包版本锁定文件
│   ├── package.json           # 包管理文件
│   ├── postcss.config.js      # PostCSS 配置文件
│   ├── svelte.config.js       # Svelte 配置文件
│   ├── tailwind.config.js     # Tailwind CSS 配置文件
│   ├── tsconfig.json          # TypeScript 配置文件
│   └── vite.config.ts         # Vite 配置文件

• src/: 包含项目的所有源代码。
• static/: 存放静态资源，如图片、字体文件等。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• .npmrc: npm 的配置文件，可包含项目的依赖安装配置。
• LICENSE.md: 项目所使用的开源许可证。
• README.md: 项目说明文件，包含项目信息和如何使用。
• build.config.json: 构建配置文件，定义构建过程。
• package-lock.json: 包版本锁定文件，确保安装的依赖版本一致。
• package.json: 包管理文件，定义项目的依赖和脚本。
• postcss.config.js: PostCSS 配置文件，用于处理 CSS。
• svelte.config.js: Svelte 配置文件，用于配置 Svelte 框架。
• tailwind.config.js: Tailwind CSS 配置文件，用于定义样式。
• tsconfig.json: TypeScript 配置文件，用于配置 TypeScript。
• vite.config.ts: Vite 配置文件，用于配置 Vite。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 中的脚本实现：

• npm run dev: 启动开发服务器，通常用于本地开发调试。
• npm run build:svelte: 构建纯 Svelte 应用程序。
• npm run dev:electron: 以开发模式启动 Electron 应用程序。
• npm run build:electron: 构建 Electron 应用程序的可执行文件。

3. 项目的配置文件介绍

项目中有多个配置文件，以下是一些主要的配置文件介绍：

• build.config.json: 定义构建过程的配置，如构建命令、输出目录等。
• package.json: 包含项目的名称、版本、描述、依赖、脚本等信息。
• postcss.config.js: 配置 PostCSS 的插件和预设。
• svelte.config.js: 配置 Svelte 的编译选项和插件。
• tailwind.config.js: 配置 Tailwind CSS 的设计指南，如颜色、字体大小等。
• tsconfig.json: 配置 TypeScript 的编译选项。
• vite.config.ts: 配置 Vite 的开发和构建过程，如代理、环境变量等。

通过上述配置文件，开发者可以定制化和优化项目的开发流程和最终输出。