Doxxy

A Discord bot to help guide users of the JDA library.

Features

• Search docs (JDA & JDK 17), with support for partial matching:
  • Typing anything will search for classes and methods
  • Typing a class name, followed by a # and a name, will search for methods in a class
    • For example, rest#comp will give, among other results, RestAction#complete()
  • Constant fields can be searched by typing in all caps, like Message#MAX_COMPONENT_CONUT.
• Sending Maven/Gradle/Gradle KTS build scripts
• Sending Logback configurations
• Getting the latest versions and snapshots
• Sending user-created code examples
• Formatting code
• Tags

Modules

• doxxy-commons: Common source code used by both the bot and the backend
• doxxy-bot: Main Discord bot
• doxxy-backend: Backend optionally used by the bot
• doxxy-docs: Parses Javadoc pages

Contributing

Requirements

• JDK 24+
  • Configure your IDE to run Gradle with it
• A PostgreSQL 13 or higher database

Set up

1. Clone repo
2. Copy config-template as config
3. Delete logback.xml as it's configured for production
4. Copy .env.example as .env and set the values, values are required unless commented otherwise

Then follow the instructions of the module you want to contribute to.

Deployment

1. Clone repo
2. Copy config-template as config
3. Change profile from dev to prod in config/application.yaml
4. Copy .env.example as .env and set the values, values are required unless commented otherwise
5. Run docker compose up -d to start the application stack