Skip to content

This bot helps teams keep track of shared devices (like a common office laptop) through manual check-ins. Users register each time they take or return the device. The bot logs usage count and shows who last used it, ensuring transparent and organized sharing.

License

Notifications You must be signed in to change notification settings

WinkyTy/SimpleDeviceShare

Repository files navigation

SimpleDeviceShare Bot (Public Demo)

A simple Telegram bot for sharing a physical device among team members. This project is designed for public showcase and educational purposes.

Features

  • User registration and schedule
  • Request device usage (max 2 per user per day)
  • Track device location ("I took the device" / "I returned the device")
  • Admin can add users and assign schedules
  • Overdue notifications for device not returned
  • All logic is in-memory (no database)

Quick Deploy on Railway

Deploy on Railway

Railway Deployment Steps:

  1. Click the "Deploy on Railway" button above
  2. Connect your GitHub account
  3. Set environment variables in Railway dashboard:
    • BOT_TOKEN: Your Telegram bot token (required)
    • ADMIN_USER_ID: Telegram user ID for admin features (optional)
  4. Deploy! The bot will start automatically

Local Setup

  1. Clone this repo
  2. Install requirements: pip install -r requirements.txt
  3. Set environment variables:
    • BOT_TOKEN (Telegram bot token)
    • ADMIN_USER_ID (Telegram user ID for admin, optional)
  4. Run: python main.py

Environment Variables

  • BOT_TOKEN: Your Telegram bot token (required)
  • ADMIN_USER_ID: Telegram user ID for admin features (optional)

Getting Your Bot Token

  1. Message @BotFather on Telegram
  2. Send /newbot and follow instructions
  3. Copy the token and add it to Railway environment variables

Getting Your User ID

  1. Message @userinfobot on Telegram
  2. Copy your ID and add it as ADMIN_USER_ID (optional)

Disclaimer

  • This bot is for demonstration and educational purposes only.
  • All data is stored in memory and will be lost on restart.
  • Do not use for production or with sensitive data.
  • No warranty or support is provided.

License

Non-commercial use only. For commercial licensing, contact: t.me/winkyty

About

This bot helps teams keep track of shared devices (like a common office laptop) through manual check-ins. Users register each time they take or return the device. The bot logs usage count and shows who last used it, ensuring transparent and organized sharing.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published