Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rv178/bookbot

Verified Discord bot which uses the Google Books API to show info about books. Added to 2000+ servers!
https://github.com/rv178/bookbot

discord discord-bot discord-js javascript typescript

Last synced: 3 months ago
JSON representation

Verified Discord bot which uses the Google Books API to show info about books. Added to 2000+ servers!

Awesome Lists containing this project

README

        


bookbot



buymeacoffee


discord


# BookBot

Verified Discord bot which uses the Google Books API to show info about books.

## Commands

Available commands are listed at [https://rv178.github.io/bookbot/](https://rv178.github.io/bookbot/).

## Support

- Our [Discord](https://discord.gg/zxrrTEDkMg) server.
- Or create an [issue](https://github.com/rv178/bookbot/issues/new/choose).

## Installation

### Dependencies

Install these by visiting their websites and running their platform-specific installers.

- NodeJS (v16.9.0 or higher)
- Typescript compiler
- MongoDB
- Docker Compose\*

An asterik (\*) indicates optional dependencies.

Install JavaScript dependencies with `npm install`.

### Discord bot

Required scopes:

- `bot`
- `applications.commands`

Required bot permissions:

- Text permissions:
- Send messages
- Embed Links
- Attach Files
- Read Message History
- Use External Emoji
- Add Reactions

### Environment variables

An example configuration file can be found in the [sample.env](./sample.env) file.
Copy and rename this file to `.env` and put your bot tokens, etc. inside.

## Running

### Development

```
tsc -w
nodemon dist/index.js
```

### Production

```
yarn install
yarn build
node dist/index.js
```

or (obviously needs the optional dependency Docker Compose)

```
docker-compose up
```