Skip to content

Commit

Permalink
fixed:docs readme:: removed docs folder
Browse files Browse the repository at this point in the history
  • Loading branch information
kalanakt committed Mar 17, 2024
1 parent 75eebc3 commit b8cdf05
Show file tree
Hide file tree
Showing 52 changed files with 38 additions and 5,194 deletions.
85 changes: 38 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,58 @@
<p align="center"><a href="https://thecodexo.com" target="_blank" rel="noopener noreferrer"><img width="250" src="https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template/blob/main/pic/logo_transparent_1100x300.png" alt="Code xo logo"></a></p>
# Pyrogram Telegram Python Bot Template

<!-- <p align='center'>
<img alt="GitHub Sparkline" src="https://stars.medv.io/kalanakt/Pyrogram-Telegram-Bot-Template.svg">
</p> -->
<p align="center">
<img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/kalanakt/Pyrogram-Telegram-Bot-Template?logo=files&logoColor=f72585&style=social">
<img alt="GitHub release (by tag)" src="https://img.shields.io/github/downloads/kalanakt/Pyrogram-Telegram-Bot-Template/v1.0.0/total?color=90dbf4&logo=arlo&style=social">
<img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/kalanakt/Pyrogram-Telegram-Bot-Template?color=8eecf5&logo=anaconda&logoColor=06d6a0&style=social">
<img alt="GitHub" src="https://img.shields.io/github/license/kalanakt/Pyrogram-Telegram-Bot-Template?logo=adguard&logoColor=390099&style=social">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/kalanakt/Pyrogram-Telegram-Bot-Template?color=90e0ef&logoColor=ff4d6d&style=social">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/kalanakt/Pyrogram-Telegram-Bot-Template?logo=electron&logoColor=89fc00&style=social">
</p>
<br><br>
This is a template for creating Telegram bots using Pyrogram, MongoDB, and Python.

<a href="https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template/archive/refs/tags/v1.0.0.zip"><img alt="Download Zip file" src="https://img.shields.io/github/downloads/kalanakt/Pyrogram-Telegram-Bot-Template/v1.0.0/total?color=caf0f8&label=Download%20As%20Zip%20v1.0.0&logo=Files&logoColor=caf0f8&style=for-the-badge"></a>
## Getting Started

<h3>This repo is for telegram bot using pyrogram libray</h3>
<p>This is <a href="https://thecodexo.com" target="_blank" rel="noopener noreferrer">Codexo</a> project for develop telegram bot using pyrogram</p>
### Prerequisites

<h3>Introduction</h3>
<p>This is complete pyrogram bot. host in <a href="https://dashboard.heroku.com/" target="_blank" rel="noopener noreferrer">heroku</a>. use <a href="https://docs.pyrogram.org" target="_blank" rel="noopener noreferrer">Pyrogram Documentation</a> for develop your bot.</p>
- Python 3.7 or higher
- Pyrogram library
- MongoDB

<h3>Ecosystem</h3>
### Installing

| Version | Status | Description |
| -------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| v 1.0.0 | Stable | Simple mode & command plugin & callback plugin & database & heroku development setup & bot message script |
| - | - | - |
| - | - | - |
1. Clone the repository:

<h3>To do</h3>
```bash
git clone https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template telegrambot
cd telegrambot
```

* [ ] deploy to vps setup
* [ ] brodcast message to users
* [ ] users counter

<h3>Documentation</h3>
2. Install the dependencies:

<p>check out <a href="https://docs.pyrogram.org" target="_blank" rel="noopener noreferrer">pyrogram doc</a></p>
```bash
pip install -r requirements.txt
```

<h3>Questions</h3>
3. Set up your MongoDB database and get the connection URI.

<p>For questions and support please use <a href="https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template/discussions" target="_blank" rel="noopener noreferrer">Discussions</a>. The issue list of this repo is <strong>exclusively</strong> for bug reports and feature requests.</p>
4. Create a `.env` file in the project root and add your MongoDB connection URI and your Telegram bot token:

<h3>Issues</h3>
```plaintext
DATABASE_URI=your-mongodb-connection-uri
DATABASE_NAME=your-database-name
API_ID=your-api-id
API_HASH=your-api-hash
BOT_TOKEN=your-bot-token
```

<p>Please make sure to read the <a href="https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template/discussions/categories/issue-reporting-checklist" target="_blank" rel="noopener noreferrer">Issue Reporting Checklist</a>. before opening an <a href="https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template/issues" target="_blank" rel="noopener noreferrer">issue</a>. Issues not conforming to the guidelines may be closed immediately.</p>
5. Run the bot:

<h3>Changelog</h3>
```bash
python bot.py
```

<p>Detailed changes for each release are documented in the <a href="https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template/commits/main" target="_blank" rel="noopener noreferrer">main commits</a></p>
## Features

<h3>Stay In Touch</h3>
- Pyrogram framework for interacting with the Telegram API.
- MongoDB for storing data.
- Easily extendable for adding more features.

- [Telegram](https://t.me/TMWAD)
## Contributing

<h3>Contribution</h3>
Contributions are welcome! Please follow the standard guidelines when contributing.

<p>If you have a pyrogram-related project/component/tool/idea, add it with a <a href="https://github.com/kalanakt/Pyrogram-Telegram-Bot-Template/pulls" target="_blank" rel="noopener noreferrer">pull request</a> Thank you to all the people who contributed to this project!</p>
## License

<h3>License</h3>

[MIT](https://opensource.org/licenses/MIT)

<br>
<em align='center'>Copyright (c) 2022-present <strong>code xo</strong></em>
This project is licensed under the MIT [License](LICENSE).
9 changes: 0 additions & 9 deletions docs/css/bootstrap-responsive.min.css

This file was deleted.

9 changes: 0 additions & 9 deletions docs/css/bootstrap.min.css

This file was deleted.

149 changes: 0 additions & 149 deletions docs/css/media-queries.css

This file was deleted.

Loading

0 comments on commit b8cdf05

Please sign in to comment.