Skip to content

A simple Telegram bot written in Java to retrieve information from Metal Archives

License

Notifications You must be signed in to change notification settings

errebenito/metallumbot

Repository files navigation

MetallumBot

A simple Telegram bot written in Java to retrieve information from Metal Archives

GitHub Workflow Status Quality Gate Status Lines of Code Coverage Duplicated Lines (%) Bugs Vulnerabilities Code Smells Technical Debt Maintainability Rating Security Rating Reliability Rating openssf best practices openssf scorecard FOSSA Status

Requirements

  • Java 17+

  • Maven

Features

  • Retrieve the link to a random band's page.

  • Retrieve the first 10 upcoming albums from the upcoming albums list.

Configuration

The bot requires the following two environment variables to exist:

  • METALLUM_BOT_TOKEN: Your telegram bot token.

  • METALLUM_BOT_NAME: Your telegram bot username.

Additionally, some tests make use of the following environment variable:

  • CHAT_ID: The unique ID of the chat where the bot's messages should be sent.

Building the bot

  • Clone this repository .

    git clone https://github.com/errebenito/metallumbot or Download this repo as zip and unzip.

  • Go to the metallumbot folder.

  • In your command line of choice, type the following:

    mvn clean package (optionally add -DskipTests to skip execution of tests).

This will build metallumbot-X.Y.Z.jar in the target directory, where X.Y.Z is the current version number for the bot.

License

Released under the GNU General Public License version 3 or, at your option, any later version. See LICENSE.md for details.

License

FOSSA Status

About

A simple Telegram bot written in Java to retrieve information from Metal Archives

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •