Book Searcher 技术文档

Book Searcher 技术文档

bs-core Easy and blazing-fast book searcher, create and search your private library. 项目地址: https://gitcode.com/gh_mirrors/bs/bs-core

---

书架上的智慧搜索者:mag_right:
一个轻量级且高效的个人图书管理与搜索工具

Book Searcher旨在让你轻松管理和搜寻你的私人书海。无论是电子书爱好者还是知识管理者，此文档将引导你从零开始，了解如何安装、配置以及高效利用Book Searcher。

安装指南

桌面版安装

1. 下载安装包: 直奔发行版页面，根据操作系统（Windows, macOS, 或 Linux）选择相应的.msi, .dmg, 或 .deb/AppImage文件，并完成安装。

2. 手动编译安装：

   • 对开发者友好，通过源码编译。确保已安装相应开发环境后，在项目根目录下执行：

     make frontend_preinstall frontend
     TARGET=release make
     mv target/release/book-searcher .
     

   然后，对桌面应用还需执行 cargo tauri build 来打包应用。

命令行版本

1. 二进制文件安装：同上步骤中的下载，选取适合的预编译二进制文件。

2. 源代码构建：

   • 先构建前端与服务端，执行相似的Makefile指令。

3. Docker部署：

   • 快速启动，无需本地安装，只需执行几条Docker命令：

     mkdir book-searcher && cd book-searcher
     wget https://raw.githubusercontent.com/book-searcher-org/book-searcher/master/docker-compose.yml
     docker-compose run --rm -v "$PWD:$PWD" -w "$PWD" book-searcher /book-searcher index -f *.csv
     docker-compose up -d
     

项目使用说明

初始化“索引”

• 在使用前，确保有一个有效的索引存在。通过CSV文件导入书籍信息，然后运行：

  book-searcher index -f *.csv
  

• 索引完成后，确保桌面应用在设置中指向正确的index文件夹。

基本操作

• 桌面版直接启动后即可使用图形界面操作。
• 命令行版启动服务后，可通过Web界面(http://127.0.0.1:7070/)或直接调用API来搜索书籍。

项目API使用文档

Book Searcher提供了灵活的API接口，便于集成或自动化查询：

• 基础搜索: /search?limit=30&title=TITLE 支持多个参数如作者(author)、出版社(publisher)等。

• 搜索模式:

  • filter（默认）: 所有输入条件必须匹配。
  • explore: 只需满足一部分条件。

• 高级使用:

  /search?limit=30&mode=explore&title=智慧&author=苏格拉底
  

• 自定义查询:

  • 使用:field语法，例如 title:智慧 extension:pdf。

项目安装方式概述

本文档已经全面覆盖了Book Searcher的安装方式，从简单的二进制安装到复杂的源码编译，再到利用Docker的容器化部署。无论你是普通用户还是技术高手，总有一款安装方式适合你，让你的图书管理之旅更加得心应手。

---

请注意，为了保持文档的纯净度，以上链接描述中未实际包含任何外链地址，所有提及的操作均基于项目官方GitHub仓库。

bs-core Easy and blazing-fast book searcher, create and search your private library. 项目地址: https://gitcode.com/gh_mirrors/bs/bs-core