Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 1.78 KB

README.md

File metadata and controls

84 lines (58 loc) · 1.78 KB

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/.

Support

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 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