HarukaAya is an open source Telegram group manager bot, this is a modular based Telegram Python Bot running on Python3 with sqlalchmey database.

This bot can be found and used on telegram as Haruka Aya.

• Help localize the bot with Crowdin
• Haruka Aya Support
• Haruka Aya's News
• Intellivoid
• Intellivoid Discussions
• Intellivoid Community

If you want to join our group chats, we advise that you read the rules carefully before participating in them.

First what you want to do is prepare the configuration file for Haruka Aya, copy sample_config.yml to config.yml and begin to fill out all the required information

Just talk to BotFather (described here) and follow a few simple steps. Once you've created a bot and received your authorization token, that's it! that's your bot_token.

In order to obtain an API key and hash you need to do the following:

• Sign up for Telegram using any application.
• Login to your Telegram core: https://my.telegram.org.
• Go to 'API Development tools' and fill out the form.
• You will get basic addresses as well as the api_id and api_hash parameters required for Haruka's configuration file.

• PostgreSQL
• Docker (optional)
• Python3.6

Run with docker! you can a local instance of haruka from the production branch using the Dockerfile

docker build -t="haruka" -f Dockerfile .
docker run -t --name haruka --restart always haruka

pip install -r requirements.txt
python -m haruka

HarukaAya will have multiple branches for different purposes, these are the main branches you should understand before contributing to this project.

• production This is the production branch that the server (or Dockerfile) will pull from and run Haruka Aya. This is the most stable branch, and it's ready for production. We do not push experimental or patches to this branch until we can confirm that it's stable for production

• master This is the next thing to production in terms of stable, here this is where all new changes are pushed before they are merged into the production branch. This is like the testing branch where we would run in test environment to double check before pushing to production. Everything pushed to this branch must be stable and finished.

Any other branches should be treated as work in progress features that is currently being worked on to release to production.

• You must sign off on your commit.
• You must sign the commit via GPG Key.
• Make sure your PR passes all CI.

• RealAkito - Original Haruka Aya Owner
• Davide - For designing and creating Haruka Aya's display picture and banner
• zakaryan2004 - For helping out a lot with this project.
• MrYacha - For Yana :3
• Skittle - For memes and sticker stuff.
• 1mavarick1 - Introducing Global Mutes, etc.
• AyraHikari - Reworked Welcome, Fed v2
• Paul Larsen - Marie and Rose creator

And much more that we couldn't list it here!