telegrambot / README.md
Captain Ezio
Update README.md
ba7eb42
|
raw
history blame
6.66 kB
<h1 align="center">
<b> Gojo_Satarou </b>
<!---</h1>
<h1 align="center"><img src="https://media.giphy.com/media/GL42TduR8AkNq1xRog/giphy.gif" /></h1> --->
<h1 align="center"><img src="https://te.legra.ph/file/4bf3b88115068d41efadd.jpg" /></h1>
------
<!------
[![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)
------>
**A python and [pyrogram](https://github.com/iamgojoof6eyes/pyrogram) based group management bot for telegram.
If you like the bot make sure to give a ⭐ __star__ ⭐ to this respository and feel free to update and sending pull requests**
---------
## 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.
**If you counter any problem or face any bugs for help join 🌟 [Hell Community](https://t.me/HellBot_Network) 🌟.**
## Features
* Modern
* Fast
* Fully asynchronous
* Fully open-source
* Frequently updated
Can be found on Telegram as [@iamgojoof6eyes_bot](https://t.me/iamgojoof6eyes)
## Bot
![Gojo Starou](https://media.giphy.com/media/hbKBe6j3JLsNnb4h53/giphy.gif)
**I am available on telegram** ***[Gojo Satarou](https://t.me/iamgojoof6eyes_bot)***
---------
# 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 gudie is given below
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 wait for 10-15 minutes.
* `Mandaotry` keys are [given below](#Variables)
* `All keys` are listed [here](https://telegra.ph/Captain-03-27)
* ***The bot can be used by provideing mandotry variables only..***
--------
## Deploy To Okteto
[![Develop on Okteto](https://okteto.com/develop-okteto.svg)](https://cloud.okteto.com/deploy?repository=https://github.com/iamgojoof6eyes/Gojo_Satarou)
### How To Deploy On Okteto
* **Make sure you have an github account.**
* [Fork](https://github.com/iamgojoof6eyes/Gojo_Satarou/fork) the repo and give a star to repo
* Click on [deploy](https://cloud.okteto.com/deploy?repository=https://github.com/iamgojoof6eyes/Gojo_Satarou) button provided above...
* Login using github.
* 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 wait for 10-15 minutes.
* If logs show error click on redeploy then ``variable`` if the variable is not there fill it and then click ``relaunch``
* ``Mandaotry`` keys are [given below](#Variables)
* ``All keys`` are listed [here](https://telegra.ph/Captain-03-27)
* ***The bot can be used by provideing mandotry variables only..***
***In case the button doesn't work just fork the repo give it a star open okteto login using github give okteto access to your github account repo search for your the bot repo add the key and values provided [below](#Variables) and wait for few minutes***
--------
## 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`
<!---### Using 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
`BOT_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.
To get a list of all variable click [here](https://telegra.ph/Captain-03-27)
---------
# Special Thanks ❀️
[PSYREX](https://github.com/iamPSYREX)
---------
# Powered by [HELL](https://github.com/The-HellBot)
[![Hell Community](https://te.legra.ph/file/a780adeb9b406b169a889.jpg)](https://github.com/The-HellBot)