https://github.com/harababurel/telereads

Find books on Goodreads and share them quickly in Telegram chats.
https://github.com/harababurel/telereads

books bot goodreads goodreads-api rust telegram telegram-bot telegram-bot-api

Last synced: 23 days ago
JSON representation

Find books on Goodreads and share them quickly in Telegram chats.

• Host: GitHub
• URL: https://github.com/harababurel/telereads
• Owner: harababurel
• License: mit
• Created: 2018-02-05T17:22:29.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-07T19:45:59.000Z (about 1 year ago)
• Last Synced: 2024-09-14T12:55:56.255Z (about 2 months ago)
• Topics: books, bot, goodreads, goodreads-api, rust, telegram, telegram-bot, telegram-bot-api
• Language: Rust
• Homepage: https://telegram.me/TelereadsBot
• Size: 99.6 KB
• Stars: 43
• Watchers: 5
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Telereads =  [Telegram](https://telegram.org/) + [Goodreads](https://www.goodreads.com/)

[![Telegram](https://img.shields.io/badge/telegram-TelereadsBot-blue?logo=telegram&style=flat)](https://telegram.me/TelereadsBot)

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/harababurel/telereads/blob/master/LICENSE)

[@TelereadsBot](https://telegram.me/TelereadsBot) is an inline bot that allows you to search for books and quickly share them in a conversation.

## Demo

![Search by book title](https://thumbs.gfycat.com/HelpfulSparseKomododragon-size_restricted.gif)

![Search by ISBN](https://thumbs.gfycat.com/FlamboyantDistinctCaimanlizard-size_restricted.gif)

## Deploy your own

You can deploy your own instance of this bot. You will need a few things:

* A Telegram bot token. Contact [@BotFather](http://telegram.me/BotFather) in order to create a new bot and receive a token.

* A Goodreads API key. Apply for one [here](https://www.goodreads.com/api).

* A working installation of [Rust](https://www.rustup.rs/).

Once you have both of these keys, you need to store them as environment variables:

```bash

$ export TELEGRAM_TOKEN="123456789:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

$ export GOODREADS_TOKEN="XXXXXXXXXXXXXXXXXXXX"

```

And then install and run TelereadsBot:

### From GitHub

```bash

$ git clone https://github.com/harababurel/telereads.git

$ cd telereads

$ RUST_LOG=info cargo run --release

```

Aditionally, this repo includes a systemd service file ([telereads.service](https://github.com/harababurel/telereads/blob/master/telereads.service)) which can be used to deploy the bot. After setting the proper variables in the service file:

```bash

$ systemctl start telereads

```

### From crates.io

```bash

$ cargo install telereads

$ RUST_LOG=info telereads

```

## Contributing

Contributions are welcome. You can also help by reporting or fixing [bugs](https://github.com/harababurel/telereads/issues).