managementbot / README.md
Captain Ezio
Update README.md
d273d16
|
raw
history blame
5.46 kB
# Gojo_Satarou
![Gojo_Satarou](https://media.giphy.com/media/GL42TduR8AkNq1xRog/giphy.gif)
A python and [pyrogram](https://github.com/iamgojoof6eyes/pyrogram) based group management bot for telegram.
<!------
[![GitHub forks](https://img.shields.io/github/forks/iamgojoof6eyes/Gojo_Satarou?&style=flat-square&logo=github)](https://github.com/iamgojoof6eyes/Gojo_Satarou/fork)
[![GitHub stars](https://img.shields.io/github/stars/iamgojoof6eyes/Gojo_Satarou?&style=flat-square&logo=github)](https://github.com/iamgojoof6eyes/Gojo_Satarou/stargazers)
![Repo Size](https://img.shields.io/github/repo-size/iamgojoof6eyes/Gojo_Satarou?&style=flat-square&logo=github)
![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green?&style=flat-square)
[![GitHub license](https://img.shields.io/github/license/iamgojoof6eyes/Gojo_Satarou?&style=flat-square&logo=github)](https://github.com/iamgojoof6eyes/Gojo_Satarou/master/LICENSE)
[![Python](https://img.shields.io/badge/Python-v3.9-blue)](https://www.python.org/)
![Branch](https://img.shields.io/badge/Branch-Master-orange)
![GitHub language count](https://img.shields.io/github/languages/count/iamgojoof6eyes/Gojo_Satarou?color=Pink&label=Language&style=flat-square)
------>
If you like the bot make sure to give a ⭐ __star__ ⭐ to theis respository and feel free to update and sending pull requests...
## ⚡ Credit ⚡
### Devs 😎
[Captain Ezio](https://github.com/iamgojoof6eyes) `Creator & Dev`
[Hêllẞøy](https://github.com/HellBoy-OP) `Dev`
[PSYREX](https://github.com/iamPSYREX) `Logo and picture designer`
### Inspiration ✨
`Not a particular inspiration inspired by many bots`
```
This bot is mixture of the many bots and have some extra plugins so it is quite better than both of bots.
```
## Group Management
The Gojo Satarou is a powerful Group Management bot.
Can be found on telegram as a management bot for groups.
Join 🌟 [Hell Community](https://t.me/HellBot_Network) 🌟 if you counter any problem or face any bugs for help.
## Features
* **Modern**
* Fast
* Fully asynchronous
* Fully open-source
* Frequently updated
* Multi Language Support
Can be found on Telegram as @iamgojoof6eyes_bot
Alita is currently available in 1 Language as of now:
* US English
More languages can be managed in the locales folder.
We are still working on adding new languages.
Help us bring more languages to the bot by contributing to the project on [Crowdin](https://crowdin.com/project/gojosatarou)
## Bot
![Gojo Starou](https://media.giphy.com/media/hbKBe6j3JLsNnb4h53/giphy.gif)
I am available on telegram [Gojo Satarou](https://t.me/iamgojoof6eyes_bot)
# Powered By [Hell Community](https://github.com/The-HellBot)
# DEPLOYMENT 🚀
## Deploy To Heroku
**Make Sure you have Heroku account**
If you don't have heroku account what are you waiting for click [here](https://id.heroku.com/login) to make one or just deploy on [railway app](#Deploy To Railway)
Just click on the button it will redirect you to Heroku website and deploy your bot there....enjoy 😉
[![DEPLOY](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/iamgojoof6eyes/Gojo_Satarou.git)
<!---## Deploy To Railway
[![DEPLOY](https://railway.app/button.svg)](https://railway.app)
### How To Deploy On Railway
* **Make Sure You have an github account which is minimum 30 days old.**
* Fork the repo by clicking [here](https://github.com/iamgojoof6eyes/Gojo_Satarou/fork)
* Click on [deploy](https://railway.app) button
* Login in railway using github account
* Now search the repo in the search bar given like iamgojoof6eyes/Gojo_Satarou ***replace iamgojoof6eyes with your github username.***
* Now add the values and keys by creating values and keys ***Make sure to add keys __as per given below__ I'll advide you to just copy and paste it***
* Then 10-15 minutes.
* Mandaotry keys are [given below](#Variables)
* All keys are listed [here](https://telegra.ph/Captain-03-23)
* ***The bot can be used by provideing mandotry variables only..*** --->
## Deploy locally
### Using git
* Install Python v3.7 or later from Python's Website
* Install virtualenv using `python3 -m pip -U install virtualenv`.
* Fork or Clone the project using `git clone https://github.com/iamgojoof6eyes/Gojo_Satarou.git`
* Create Virtualenv using: `virtualenv venv`
* Install the requirements using `python3 -m pip install -r requirements.txt`
* Fill in all the variables in Development class, not Config class. Sudo, Dev, Whitelist users are optional!!
* Change to virtualenv shell by using: `. venv/bin/activate (Linux) venv\Scripts\activate (Windows)`
* Run the bot using `python3 -m Powers`
### Usind docker
Clone the repo and enter into it
Install [Docker](https://www.docker.com/)
Fill in the `sample.env` file and rename it to `main.env`.
Build the docker image using: `docker build -t Gojo_Satarou:latest .` (The dot '.' at last is necessary!)
Run the command `docker run --env-file main.env Gojo_Satarou`
If all works well, bot should send message to the MESSAGE_DUMP Group!
## Variables
`TOKEN` You can get your bot token at @BotFather
`API_ID` You can get your api id [here](my.telegram.org)
`API_HASH` You can get your api hash [here](my.telegram.org)
`PREFIX_HANDLER` Your bot handler which will activate commands
`DB_URI` Your MongoDB connection string.
`APP_ID` Get API_ID from my.telegram.org, used for pyrogram base.