Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ShivangKakkar/UrbanDictionaryBot

https://t.me/StarkBots
https://github.com/ShivangKakkar/UrbanDictionaryBot

Last synced: 24 days ago
JSON representation

https://t.me/StarkBots

Awesome Lists containing this project

README

        

# Urban Dictionary Bot [@TheUrbanDictBot](https://t.me/TheUrbanDictBot)

> A star ⭐ from you means a lot to us!

Telegram bot for Urban Dictionary.

[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

## Usage

### Deploy to Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/StarkBotsIndustries/UrbanDictionaryBot)

1. Tap on above button and fill `API_ID`, `API_HASH`, `BOT_TOKEN`.
2. Then tap "Deploy App" below it. Wait till deploying is complete (will take atmost 2 minutes).
3. After deploying is complete, tap on "Manage App"
4. Check the logs to see if your bot is ready!

### Local Deploying

1. Clone the repo
```markdown
git clone https://github.com/StarkBotsIndustries/UrbanDictionaryBot
```
2. Edit `Config.py` and fill the needed variables

3. Enter the directory
```markdown
cd UrbanDictionaryBot
```
4. Run the file
```markdown
python3 udbot.py
```

## Environment Variables

#### Mandatory Vars

- `API_ID` - Get this from [my.telegram.org](https://my.telegram.org/auth)
- `API_HASH` - Get this from [my.telegram.org](https://my.telegram.org/auth)
- `BOT_TOKEN` - Get this from [@BotFather](https://t.me/BotFather)

## Functions

> More features soon, this is a minimal example :)

1. Usable in Inline Mode
2. Add in groups
3. Use in personal chat
4. No need to browse ud anymore

## To-Do

> That's on you mainly...

## Stats

[![GitHub forks](https://img.shields.io/github/forks/StarkBotsIndustries/UrbanDictionaryBot.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/StarkBotsIndustries/UrbanDictionaryBot/network/) [![GitHub stars](https://img.shields.io/github/stars/StarkBotsIndustries/UrbanDictionaryBot.svg?style=social&label=Star&maxAge=2592000)](https://github.com/StarkBotsIndustries/UrbanDictionaryBot/stargazers/) [![GitHub watchers](https://img.shields.io/github/watchers/StarkBotsIndustries/UrbanDictionaryBot.svg?style=social&label=Watch&maxAge=2592000)](https://github.com/StarkBotsIndustries/UrbanDictionaryBot/watchers/)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/StarkBotsIndustries/UrbanDictionaryBot/graphs/commit-activity)

## License

[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

## Contributing

[![GitHub contributors](https://img.shields.io/github/contributors/StarkBotsIndustries/UrbanDictionaryBot.svg)](https://github.com/StarkBotsIndustries/UrbanDictionaryBot/graphs/contributors/)

> Contributions are heartily accepted.

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

## Credits

- [Dan Tès](https://github.com/delivrance) for his [Pyrogram](https://docs.pyrogram.org) Library

## Support

Channel :- [@StarkBots](https://t.me/StarkBots)

Group Chat :- [@StarkBotsChat](https://t.me/StarkBotsChat)

## :)

[![ForTheBadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)

[![ForTheBadge built-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://github.com/StarkBotsIndustries)

[![ForTheBadge makes-people-smile](http://ForTheBadge.com/images/badges/makes-people-smile.svg)](https://github.com/StarkBotsIndustries)