Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 1.38 KB

README.md

File metadata and controls

34 lines (19 loc) · 1.38 KB

Chronomancy

Chronomancy is a handy little time converter bot for Discord!

When someone in your server posts a message containing a time, Chronomancy will give you a button to let you convert the time into your own timezone without any hassle.

Chronomancy is written in Kotlin, with Diskord giving us access to the Discord bot APIs and Ktor backing our REST API server.

Development

Configuration

Before working with the bot, you must create and populate a local.properties file at src/main/resources/local.properties.

We recommend you copy the local_sample.properties sample file as it contains all the configuration options that are required by the bot.

Run locally

You can run ./gradlew run from the command line to launch the bot. You can run/debug the bot by running the Run Bot configuration within IntelliJ.

Build

Run ./gradlew clean build to build the project.

Running unit tests

Run ./gradlew test to run the unit tests.

Lint the source files

Run a static analysis check using Detekt and ktlint over the source files by executing ./gradlew check.