开源项目BS-Core安装配置指南

开源项目BS-Core安装配置指南

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

项目基础介绍及编程语言

BS-Core 是一个高效的私人图书搜索引擎项目，它允许用户快速建立并查询自己的书籍库。此项目以速度著称，能够在一分钟内索引超过10百万本书的元数据，并在微秒级别执行搜索操作。BS-Core提供了桌面版和命令行接口（CLI）两种版本，满足不同用户的使用需求。项目的编码主要采用了 TypeScript 和 Rust 这两种语言，结合 Docker 技术进行便捷部署。

关键技术和框架

• 前端: 主要使用 TypeScript 进行开发，确保了代码的类型安全和高性能。
• 后端: 利用了 Rust 的高效率特性来实现核心搜索逻辑，保证快速响应。
• 容器化: 通过 Docker 实现应用的简便部署，提高环境一致性。
• Tauri: 用于构建轻量级的跨平台桌面应用，适用于桌面版的开发。
• Web UI: 提供了一个基于Web的用户界面，便于用户操作和搜索。

安装和配置步骤

准备工作

1. 安装Git: 确保您的机器上已安装Git，用于克隆仓库。
2. 安装Node.js: 因为前端使用TypeScript编译，所以需要Node.js。
3. 安装Rust: 对于后端部分，您需要安装Rust及其包管理器Cargo。
4. Docker: 如果选择使用Docker部署，则需预先安装Docker环境。

安装步骤

克隆项目

打开终端或命令提示符，运行以下命令来克隆项目：

git clone https://github.com/zu1k/bs-core.git
cd bs-core

桌面版安装（可选）

1. 构建前端：

   make frontend_preinstall
   make frontend
   

2. 构建桌面应用：

   cargo tauri build
   

CLI版本安装

1. 构建CLI工具： 首先，确保已安装Rust，然后在项目根目录下运行：

   cargo build --release
   

   编译完成后，target/release/book-searcher 即为可执行文件。

2. 准备指数文件（需要CSV格式的书籍元数据）。

使用Docker部署（简易方式）

1. 下载并准备Docker配置： 在项目目录下运行：

   mkdir book-searcher; cd book-searcher
   wget https://raw.githubusercontent.com/book-searcher-org/book-searcher/master/docker-compose.yml
   

2. 准备指数：将CSV文件放入该目录，并运行命令创建索引：

   docker-compose run --rm -v "$PWD:$PWD" -w "$PWD" book-searcher /book-searcher index -f *.csv
   

3. 启动服务：

   docker-compose up -d
   

   服务现在应该监听在 0.0.0.0:7070 上。

测试与验证

• CLI: 运行 ./target/release/book-searcher run 后，可以通过浏览器访问 http://localhost:7070/ 来查看Web界面，或者直接使用API进行搜索。
• Docker: 直接访问 http://localhost:7070/ 即可开始使用搜索功能。

至此，您已经完成了BS-Core项目的安装和配置，可以开始享受便捷的私人图书馆检索体验了。

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