Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dcdunkan/bible-bot
A simple Telegram Bot for reading the whole Bible in 80+ translations inside Telegram.
https://github.com/dcdunkan/bible-bot
bible deno deta deta-base getbible grammyjs telegram-bot typescript
Last synced: 3 months ago
JSON representation
A simple Telegram Bot for reading the whole Bible in 80+ translations inside Telegram.
- Host: GitHub
- URL: https://github.com/dcdunkan/bible-bot
- Owner: dcdunkan
- License: mit
- Created: 2022-02-23T05:52:59.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-02T04:07:14.000Z (over 1 year ago)
- Last Synced: 2024-10-03T13:22:09.871Z (4 months ago)
- Topics: bible, deno, deta, deta-base, getbible, grammyjs, telegram-bot, typescript
- Language: TypeScript
- Homepage: https://telegram.me/scripturbot
- Size: 55.7 KB
- Stars: 21
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Bible Bot
### Try official public instance of the bot here: [Scripture Bot](https://telegram.me/scripturbot)
Bible Bot, for reading the whole Bible in 80+ translations inside Telegram. You
can read the bible, request a passage by sending the reference and customize
your experience.
> This is a complete re-write and modified version of the previous version: 3,
> which you can find here:
> [dcdunkan/bible-bot-v3](https://github.com/dcdunkan/bible-bot-v3).
Re-written in [TypeScript](https://typescriptlang.org) and
[grammY](https://grammy.dev/) and now it runs on [Deno](https://deno.land/).
- [Built Using](#built-using)
- [Features](#features)
- [Setup › Running Locally](#running-locally)
- [Setup › Deno Deploy](#deno-deploy)
- [Setup › Environment Variables](#environment-variables)
## Built Using
Thanks to these tools and libraries.
1. _[GetBible.net API](https://getbible.net)_ — A simple API used for fetching
the Scripture data for the various translations.
2. _[grammY](https://grammy.dev)_ - The coolest Telegram Bot Framework.
3. _[Deta Space Database](https://deta.space)_ - Free and unlimited Cloud
Database service.
## Features
- **Read the whole Bible in 80+ translations** (Does not require any manual
updating by this bot, it should update as the GetBible API data updates). Use
the `/translations` or `/read` command in chat.
- **Request a passage by sending the reference**. You can find the accepted book
names and formats by sending `/valid_references` in chat.
- Set a default translation. You don't have to do `/translations` every time and
choose one. You can set a default one using `/default`. And this will be used
when using `/read` command and requesting passages.
- **Bookmarks**. Click on the 🔖 button to bookmark a page and ❌🔖 to remove
it. Use `/bookmarks` to list all of your bookmarks.
- **Customize your experience** with the options (You can suggest something new
by opening an issue or by contributing) in the `/settings` menu.
- **I was reading ABC last day.** Ah, use `/last` to get back to the last read
page.
I really want to add more features like, using _inline to share verses_, or
something like a _verse image generator_, maybe? **Maybe** sometime in future.
## Setup
### Running Locally
Make sure you have installed [Deno](https://deno.land).
- Clone the repository.
```bash
git clone https://github.com/dcdunkan/bible-bot.git
```
- Change directory (`cd`) to the cloned repository.
- Create a `.env` file and set [environment variables](#environment-variables)
like in [`.env.example`](.env.example). Make sure you have set `LOCALLY` to
`1`.
- Run the bot using the command below.
```bash
DEBUG=1 deno run \
--allow-net --allow-env --allow-read --allow-write \
main.ts
```
> Or set `DEBUG=grammy*` to see the debug logs.
**Required permissions**
- `--allow-net` - To communicate with Telegram servers and receive updates.
- `--allow-env` - To access environment variables.
- `--allow-read` - To read cached files.
- `--allow-write` - To cache files.
### Deno Deploy
The working bot, [@scripturbot](https://telegram.me/scripturbot) is currently
deployed on **[Deno Deploy](https://deno.com/deploy) (Beta 3)**. Even though I
have implemented a fine getbible.net API call caching system, it's not being
used since Deno Deploy currently does not provide file system writing access. If
you're deploying to Heroku or some other, you should be able to enable caching
by providing a `USE_CACHE=1` in [environment variables](#environment-variables).
Click the button to deploy to [Deno Deploy](https://deno.com/deploy).
[](https://dash.deno.com/new?url=https://raw.githubusercontent.com/dcdunkan/bible-bot/main/mod.ts&env=BOT_TOKEN,DETA_KEY)
Or
click
here
After deploying you will get a link to your application, in the format
`https://.deno.dev/`.
Open browser and go to the link down below.
- Replace the `` with your `BOT_TOKEN`.
- Replace `` with the link to your application.
`https://api.telegram.org/bot/setWebhook?url=`
This will set the bot's webhook to the deployed application, so it will be able
to handle updates.
### Environment Variables
| Variable | Required? | Description |
| ----------- | --------- | -------------------------------------------------------------------------------- |
| `BOT_TOKEN` | **Yes.** | The API token of the Bot. Chat with https://t.me/BotFather to get one. |
| `DETA_KEY` | **Yes.** | Project Key of Deta.sh Project. Sign up and create a project at https://deta.sh. |
| `USE_CACHE` | No. | Set the value to 1 if you want caching to work. |
## License
This application is licensed under the MIT License. See the LICENSE file for
more information on copying and distributing this piece of software.
## Contributing
Contributions are very welcomed here! Want to suggest a feature or report an
issue? Feel free to open issues and pull requests if you're working on it.
---
_In loving memory of my friend Shamil._
**Made with just <3**