Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeeshanahmad4/friendtech-notifier-bot-ftnb-
🤖 FriendTech Notifier Bot (FTNB): Instantly get notified when someone of interest joins the `friend.tech` platform!
https://github.com/zeeshanahmad4/friendtech-notifier-bot-ftnb-
api automation bot notifications python user-registration user-registration-app web-integration
Last synced: 22 days ago
JSON representation
🤖 FriendTech Notifier Bot (FTNB): Instantly get notified when someone of interest joins the `friend.tech` platform!
- Host: GitHub
- URL: https://github.com/zeeshanahmad4/friendtech-notifier-bot-ftnb-
- Owner: Zeeshanahmad4
- Created: 2023-08-31T12:15:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-25T23:16:41.000Z (4 months ago)
- Last Synced: 2024-08-26T00:51:32.697Z (4 months ago)
- Topics: api, automation, bot, notifications, python, user-registration, user-registration-app, web-integration
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Table of Contents
- [Project Overview](#project-overview-)
- [Features](#features-)
- [Future Features (To-Do)](#-future-features-to-do)
- [Requirements](#requirements-)
- [Usage Examples](#usage-examples-)
- [Setup and Installation Instructions](#setup-and-installation-instructions-)
- [Troubleshooting Tips](#troubleshooting-tips-)
- [Contribution Guidelines](#contribution-guidelines-)
## Project Overview 📖
**FriendTech Notifier Bot (FTNB)** is a specialized bot designed to send instant notifications when specific users join the `friend.tech` platform. Stay updated and never miss when someone of interest registers on the platform!
## Features ✨
- **Real-time Monitoring**: Monitors `friend.tech` for new user registrations.
- **Instant Notifications**: Sends notifications immediately when a user from a predefined list joins.
- **User Customization**: Allows manual entry of usernames of interest.
- **Scalability**: Can handle a list of up to 50 usernames.
### 🚀 Future Enhancements (To-Do):
- Integration with mobile notifications for real-time alerts on smartphones.
- Analytics dashboard to provide insights on user registration trends.
- Enhanced error handling and logging for better troubleshooting.
## Usage Examples 💡
```# To start the bot and monitor new users
from main import main
main()
```
## Setup and Installation Instructions 🔧
Clone the GitHub repository.
```git clone ```
Navigate to the project directory.
```cd friend.tech-bot ```
- Install necessary dependencies (if any).
- Update the `config/settings.py` with necessary API keys and configurations.
- Run the `main.py` script to start the bot.
```python main.py ```
## Troubleshooting Tips 🛠️
- Ensure all dependencies are correctly installed.
- Check `logs/bot.log` for any error logs or warnings.
- Ensure API keys and other configurations in `config/settings.py` are correctly set.
## Contribution Guidelines 🤝
1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine.
3. Make your changes or additions.
4. Push your changes to your fork.
5. Submit a pull request to the main repository for review.
6. After review, your changes might be merged!