Ba Discord Bot

Ba adds reactions to messages posted in Discord channels, based upon the text within them, with matching regexes.

---

• Adding Ba to your Discord server
  • Inviting the public Ba account
  • Setting up your own instance of Ba
    • Requirements
    • Setting up a Discord bot instance
    • Inviting your instance of Ba to your server
• Using Ba
  • Ba's Reactions
• Dependencies and frameworks
• Contributing to Ba
  • Bug reports
  • Developing Ba
    • Requirements
    • Running Ba for local development
    • package.json scripts
• License

If you want to run Ba on your server, you can either invite the public Ba account or set up your own Discord bot with Ba's code.

If you want to invite the public Ba account to your server, go here.

• Node.js, v16.6.0 or higher
• Yarn Package Manager
• Docker/Docker Compose

• Sign in to Discord
• Go to the Discord Dev Portal, and click on 'My Apps'
• Click on 'New App' to create a Discord application
• Go to the Bot tab, and click the Add Bot button to create a bot user
• Copy the token under Bot/Token - you will need this in the next step

• TODO: Write this

Click the 'Generate OAuth2 URL' button in the Discord Developer pane to generate your invite URL. Using the invite URL, you can invite your instance of Ba to any Discord server on which you have administrator permissions.

You can use the /emotes command to see a list of Ba's reactions or a list of reactions can be found here.

• Discord.js - Discord API for Node.js
• ESLint - Linting
• PostgreSQL - Persistent storage
• TypeORM - Database Interaction
• TypeORM Seeding - Seeding database data
• Winston - Log management

We welcome all contributors to Ba. Your pull requests will be reviewed by the authors prior to merging. Please document your code, and play nicely with other contributors.

Please report bugs by opening an issue on GitHub.

• Docker/Docker Compose
• Node.js v16.6.0 or higher
• Yarn

1. clone the repo and move into the directory.
   

   $ git clone https://github.com/asleepysheepy/Ba.git ba && cd ba

2. Install dependencies with yarn.
   

   $ yarn install

3. Create .env file.
   

   $ cp .env.sample .env

4. Setup your evironment variables in the .env file.
5. Start the docker processes.
   

   $ docker-compose up -d

6. Run the mirgations to set up the database.
   

   $ yarn typeorm migration:run

7. Run the database seeder to create some emotes.
   

   $ yarn seed seed

8. Start Ba.
   

   $ yarn start

• yarn build - Compiles Ba's typeScript code into plain JavaScript
• yarn lint:all - Run eslint over Ba's code
• yarn lint:fix - Run eslint over Ba's code, fixing mistakes
• yarn seed - Access the typeorm-seeding CLI
• yarn start - Compile Ba and start up the bot process
• yarn typeorm - Access Typeorm's CLI

This project is licensed under the MIT License - see the LICENSE file for details