Book Searcher
Create and search books index, create your private library.
We don't save and provide files, we provide books searching.
Usage
We currently offer both Desktop and Command-line versions.
Desktop
1. Download the pre-compiled desktop installer from Release
Or you can compile by yourself. Refer to Build from source section for instructions.
- Windows: Book-Searcher-desktop_version_x64.msi
- macOS: Book-Searcher-desktop_version_x64.dmg
- Linux:
- Deb: Book-Searcher-desktop_version_amd64.deb
- AppImage: Book-Searcher-desktop_version_amd64.AppImage
2. Prepare the index
Refer to Prepare the index section for instructions.
3. Run book-searcher-desktop
Specify the index
folder path in the settings menu.
Cli
1. Download the pre-compiled binary from Release
Or you can compile by yourself. Refer to Build from source section for instructions.
2. Prepare the index
Refer to Prepare the index section for instructions.
3. Run book-searcher run
It will listen to 127.0.0.1:7070
.
Access http://127.0.0.1:7070/ to use webui, or you can use the original search api.
Deploy with Docker
mkdir book-searcher && cd book-searcher
// Prepare the index
wget https://raw.githubusercontent.com/book-searcher-org/book-searcher/master/docker-compose.yml
docker-compose up -d
Now book-searcher
it will listen to 0.0.0.0:7070
.
Original Search Api
You can search by the following fields:
- title
- author
- publisher
- extension
- language
- isbn
- id
Examples:
http://127.0.0.1:7070/search?limit=30&query=余华
http://127.0.0.1:7070/search?limit=30&query=title:机器学习 extension:azw3 publisher:清华
http://127.0.0.1:7070/search?limit=30&query=id:18557063
http://127.0.0.1:7070/search?limit=30&query=isbn:9787302423287
Build from source
Build Cli version
1. Build frontend
make frontend_preinstall frontend
2. Build book-searcher
TARGET=release make
# move the compiled binary to the project root directory
mv target/release/book-searcher .
Build Desktop version
1. Install frontend dependencies
make frontend_preinstall
2. Build book-searcher-desktop
cargo tauri build
index
Prepare the 1. Prepare the raw data
Prepare the raw books metadata and save the csv
files to the project root directory.
The raw data is used to generate the index
, see Raw data section for details.
2. Create index
You may need to rm -rf index
first.
book-searcher index -f *.csv
The finally folder structure should look like this:
book_searcher_dir
├── index
│ ├── some index files...
│ └── meta.json
└── book-searcher
Raw data
This raw data is used to generate index
, should be a csv
file with the following fields:
id, title, author, publisher, extension, filesize, language, year, pages, isbn, ipfs_cid
License
book-searcher © The Book Searcher Authors, Released under the BSD-3-Clause License.