rubook
is a command line application written in Rust that allows users to search for books, manage their collection, and download them as ebooks.
This repository contains both the front-end CLI and a backend web API built with Actix Web.
- Search for books: Easily search for books.
- Manage your collection: Keep track of the books you own and the ones you want to read.
- Download ebooks: Download books in ebook form to read on your favorite device.
- Go to the Releases page of the repository.
- Find the latest release and download the
.zip
file for your corresponding platform. - Unzip the downloaded file to a location of your choice.
- Follow the instructions below to modify the .env.sample file with your Google API key.
This project uses the Google Books API to search for and retrieve information about books. In order to use this API, you will need to obtain a Google API key and add it to a .env
file in the root of the project.
- Go to the Google Cloud Console.
- Click the project drop-down and select or create the project for which you want to add an API key.
- Click the hamburger menu and select APIs & Services > Library.
- Search for "Google Books API" and click on the result.
- Click the Enable button to enable the Google Books API for your project.
- Click the hamburger menu again and select APIs & Services > Credentials.
- On the Credentials page, click Create credentials > API key.
- The API key created dialog displays your newly created API key. Click Close.
- The new API key is listed on the Credentials page under API keys.
- Create a new file called
.env
in the root of the project. - Open the
.env
file in a text editor. - Add the following line to the file, replacing
YOUR_GOOGLE_API_KEY
with your Google API key:GOOGLE_API_KEY=YOUR_GOOGLE_API_KEY
- Save and close the
.env
file.
You can also look at or modify the .env.sample
file provided in the root of the project for an example of how to set up your .env
file.
To use Rubook, simply run the rubook
command.
Contributions to rubook
are welcome! If you would like to contribute, please fork the repository and submit a pull request with your changes.
rubook
is licensed under the MIT license. See LICENSE for more information.