Saga Reader 开源项目启动与配置教程

Saga Reader 开源项目启动与配置教程

saga-reader 💪🏻 Blazing-Fast and Extremely-Lightweight Internet Reader driven by AI! Your AI-Powered think tank assistant.(Built with Rust, Tauri & Svelte) 项目地址: https://gitcode.com/gh_mirrors/sa/saga-reader

1. 项目目录结构及介绍

Saga Reader 的项目目录结构如下：

• app/: 包含前端代码，使用 Svelte 和 SvelteKit 构建的用户界面。
• crates/: 存放 Rust 编写的各个模块，包括数据处理、模型支持等功能。
  • intelligent/: 文章优化工作流模块，提供文章优化和提示工程优化的抽象。
  • scrap/: 数据抓取功能模块，通过调用主流搜索引擎获取互联网信息。
  • recorder/: 提供本地存储功能，用户兴趣提示、原始文章和后处理优化文章保存在用户的个人电脑存储中。
  • llm/: 提供内部 LLM 提供商抽象，适配各种云和本地大型模型服务实现。
  • ollama/: 操作本地 ollama，包括运行基本实例、模型更新和管理功能。
  • feed_api_rs/: 核心能力 API 和实现，基于经典外观模式。
  • tauri-plugin-feed-api/: 通过 tauri 命令为前端调用的核心能力 API。
  • types/: 共享的基本类型模块。
• .github/: 包含 GitHub 工作流程文件，如自动化测试、构建等。
• docs/: 存放项目文档。
• gitignore: 配置 Git 忽略文件。
• Cargo.toml: Rust 项目的配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• README_zh.md: 项目说明文件的中文版本。
• bunfig.toml: Bun 配置文件。
• clippy.toml: Clippy 配置文件。
• package.json: Node.js 项目配置文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 package.json 文件中的脚本。以下是一些主要的启动脚本：

• bun run dev: 使用 Bun 运行开发服务器，适用于开发环境。
• pnpm run dev: 使用 pnpm 运行开发服务器，另一种包管理工具的选择。
• npm run dev: 使用 npm 运行开发服务器。
• bun run build: 使用 Bun 构建项目，适用于生产环境。
• pnpm run build: 使用 pnpm 构建项目。
• npm run build: 使用 npm 构建项目。

通常情况下，开发者会运行 bun run dev 来启动开发服务器，并在本地浏览器中查看应用。

3. 项目的配置文件介绍

以下是一些重要的配置文件及其用途：

• Cargo.toml: Rust 项目的配置文件，定义了项目的元数据、依赖项、构建选项等。
• package.json: Node.js 项目配置文件，定义了项目的依赖项、脚本和元数据。
• .github/workflows: GitHub Actions 工作流配置文件，用于自动化项目的某些流程，如 CI/CD。
• bunfig.toml: Bun 配置文件，提供了对 Bun 的额外配置选项。
• clippy.toml: Clippy 配置文件，用于配置 Rust 代码样式和错误检查。

确保在使用项目之前，根据项目需求和本地环境，对上述配置文件进行适当的配置和调整。

saga-reader 💪🏻 Blazing-Fast and Extremely-Lightweight Internet Reader driven by AI! Your AI-Powered think tank assistant.(Built with Rust, Tauri & Svelte) 项目地址: https://gitcode.com/gh_mirrors/sa/saga-reader