awattez/diamondbot

Diamond Bot ^v0.1.2

A custom Discord bot built using Javacord, Spring, MongoDB

Documentation | Build Instructions | Run Instructions

Documentation

The documentation of this repository's code is available via the Javadocs made available at the following GitHub page.

Note: If you wish to make any contributions to the repository, make sure to generate the Javadocs that document the entire project, including the updates made by you and put them in the '/docs' directory.

Build Instructions

For deployment on Heroku, certain changes needed to be made to the Gradle build system. Once you have the latest version of Diamond Bot's source code from GitHub pulled to your local machine, follow the below instructions to successfully build Diamond Bot.

On IntelliJ IDEA:

• Save your current configuration and click on Edit Configurations....
• Click on the + button in the top left corner of the Configurations window to add a new configuration.
• In the dropdown list that appears, select the Gradle option.
• Set the name to Build JAR.
• Under the run section, type clean bootJar javadoc and make sure the 'Gradle Project' selected is the current project's name.
• Once that is done, you are ready to build. After making the changes you wish to the code in your local repository, switch your configuration to Build JAR.
• Click the build button for the configuration. Once it has finished, click the run button for the configuration.
• An output window should pop-up showing you the tasks Gradle is performing. Once done, you should see a BUILD SUCCESSFUL message indicating that the build was successful, at the bottom of the output window. Verify this by checking if a JAR file has generated in the /build/libs directory. You should also see javadocs created/updated in the /docs directory.
• If the build was unsuccessful, Gradle will provide you with some debug info so that you can find the problem yourself and fix it.

Now your code is ready to be committed and pushed to the remote repository on GitHub. Heroku will automatically pull the latest version from the repository and run that instance.

Note: If you make changes to the 'build.gradle' file or if it is the first time Gradle is being run for the project, you will see a Gradle sync button on the screen. Make sure to click it to allow Gradle to fetch the necessary libraries required for building the project.

Run Instructions

If you wish to run the JAR file locally, you can do so by creating a 'Run JAR' configuration in your IDE.

On IntelliJ IDEA:

• Click on the + button in the top left corner of the Configurations window to add a new configuration.
• In the dropdown list that appears, select the JAR Application option.
• Set the name to Run JAR.
• Provide the path to the JAR, as well as any necessary environment variables (refer to the Setup Test Bot documentation).
• Save the configuration, select it from the configurations' dropdown menu and click the run button.
• A window should pop-up, showing the runtime messages from the JAR application's console. If all goes smoothly, you should see a Bot has started! message in the console.

If there are any runtime errors or other problems, you should see a stack trace indicating or hinting at the source of the problem. Create an issue/pull request to bring this to the notice of other contributors so that it can be resolved together.

For more information about setting up a test bot for local development and hosting purposes, refer to the Setup Test Bot documentation.