{"id":31584269,"url":"https://github.com/swapnilsoni1999/amul-notify","last_synced_at":"2025-10-06T00:59:15.220Z","repository":{"id":300243079,"uuid":"1005504496","full_name":"SwapnilSoni1999/amul-notify","owner":"SwapnilSoni1999","description":"🍫 Fastest and most reliable Amul stock checker.","archived":false,"fork":false,"pushed_at":"2025-08-30T12:15:52.000Z","size":44071,"stargazers_count":148,"open_issues_count":4,"forks_count":16,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-01T21:54:23.427Z","etag":null,"topics":["amul","bot","stock-checker","telegram"],"latest_commit_sha":null,"homepage":"https://amul.10xdev.me/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SwapnilSoni1999.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-20T10:29:46.000Z","updated_at":"2025-10-01T14:53:39.000Z","dependencies_parsed_at":"2025-06-20T16:36:21.907Z","dependency_job_id":"55322ee0-59b6-4ef8-83db-a0bd19d1ac86","html_url":"https://github.com/SwapnilSoni1999/amul-notify","commit_stats":null,"previous_names":["swapnilsoni1999/amul-notify"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SwapnilSoni1999/amul-notify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwapnilSoni1999%2Famul-notify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwapnilSoni1999%2Famul-notify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwapnilSoni1999%2Famul-notify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwapnilSoni1999%2Famul-notify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SwapnilSoni1999","download_url":"https://codeload.github.com/SwapnilSoni1999/amul-notify/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwapnilSoni1999%2Famul-notify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278542670,"owners_count":26004061,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amul","bot","stock-checker","telegram"],"created_at":"2025-10-06T00:59:14.100Z","updated_at":"2025-10-06T00:59:15.213Z","avatar_url":"https://github.com/SwapnilSoni1999.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🥛 Amul Stock Notification Bot\n\n[![Telegram](https://img.shields.io/badge/Chat-Telegram-blue?logo=telegram)](https://t.me/AmulOSSBot)\n[![GitHub stars](https://img.shields.io/github/stars/SwapnilSoni1999/amul-notify?style=social)](https://github.com/SwapnilSoni1999/amul-notify)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n![Endpoint Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fbots.10xdev.me%2Famul-bot%2Fbadge)\n\nA powerful Telegram bot that helps you track the availability of Amul's protein-rich products including protein shakes, lassi, whey protein, paneer, and more. Get real-time notifications when your favorite products are back in stock in your local area!\n\n\u003cdiv align=\"center\"\u003e\n\n**[🤖 Try the Bot Now](https://t.me/AmulOSSBot)** • **[⭐ Star on GitHub](https://github.com/SwapnilSoni1999/amul-notify)** • **[📞 Contact Developer](https://t.me/SoniSins)**\n\n\u003c/div\u003e\n\n---\n\n## ✨ Features\n\n- 🔍 **Browse Products**: View all Amul protein products with real-time availability\n- 📍 **Location-Based**: Set your pincode to get local stock updates\n- � **Smart Notifications**: Get notified instantly when tracked products are back in stock\n- � **Stock Tracking**: Monitor inventory levels and stock changes\n- ⚡ **Real-Time Updates**: Automated checks every 3 minutes\n- 📱 **User-Friendly**: Simple Telegram interface with inline buttons\n- 🎯 **Selective Tracking**: Track only the products you care about\n- 📈 **Analytics**: View bot statistics and usage data\n\n---\n\n## 🚀 Quick Start\n\n### For Users\n\n1. **Start the Bot**: [Click here to open @AmulOSSBot](https://t.me/AmulOSSBot)\n2. **Set Your Location**: Use `/setpincode YOUR_PINCODE` to set your area\n3. **Browse Products**: Use `/products` to see all available items\n4. **Track Items**: Click the \"Track\" button next to products you want to monitor\n5. **Get Notified**: Receive instant notifications when items are back in stock\n\n### Example Usage\n\n```\n/start                    # Welcome message and setup\n/setpincode 400001        # Set your pincode (Mumbai in this example)\n/products                 # Browse all protein products\n/tracked                  # View your tracked items\n/support                  # Get help and contact info\n```\n\n---\n\n## 🤖 Bot Commands\n\n| Command       | Description                              | Example              |\n| ------------- | ---------------------------------------- | -------------------- |\n| `/start`      | Initialize bot and show welcome message  | `/start`             |\n| `/setpincode` | Set your delivery pincode                | `/setpincode 400001` |\n| `/products`   | List all available Amul protein products | `/products`          |\n| `/tracked`    | Show products you're currently tracking  | `/tracked`           |\n| `/pincode`    | View your current pincode setting        | `/pincode`           |\n| `/support`    | Get support and contact information      | `/support`           |\n\n### Admin Commands (Bot Owner Only)\n\n| Command      | Description                   |\n| ------------ | ----------------------------- |\n| `/broadcast` | Send message to all bot users |\n| `/stats`     | View bot usage statistics     |\n| `/sessions`  | View active Amul API sessions |\n\n---\n\n## 🏗️ Tech Stack\n\n- **Runtime**: Node.js 18+ with TypeScript\n- **Bot Framework**: [Telegraf.js](https://telegraf.js.org/) - Modern Telegram bot framework\n- **Database**: MongoDB with Mongoose ODM\n- **HTTP Client**: Axios for API requests\n- **Caching**: Redis for performance optimization\n- **Scheduling**: node-cron for automated stock checks\n- **Process Management**: PM2 for production deployment\n- **Code Quality**: ESLint + Prettier for code formatting\n\n---\n\n## 🛠️ Development Setup\n\n### Prerequisites\n\n- Node.js 18+ and pnpm\n- MongoDB database\n- Redis server (optional, for caching)\n- Telegram Bot Token (from [@BotFather](https://t.me/botfather))\n\n### Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/SwapnilSoni1999/amul-notify.git\ncd amul-notify\n\n# Install dependencies\npnpm install\n\n# Setup environment variables\ncp .env.example .env.dev\n# Edit .env.dev with your configuration\n\n# Run in development mode\npnpm run dev\n\n# Or build and run in production\npnpm run build\npnpm start\n```\n\n### Environment Variables\n\nCreate `.env.dev` for development or `.env.prod` for production:\n\n```env\n# Bot Configuration\nBOT_TOKEN=your_telegram_bot_token\nBOT_USERNAME=YourBotUsername\n\n# Database\nMONGODB_URI=mongodb://localhost:27017/amul-notify\n\n# Redis (Optional)\nREDIS_URL=redis://localhost:6379\n\n# Bot Settings\nTRACKER_ENABLED=true\nLOG_CHANNEL_ID=your_log_channel_id\nADMIN_USER_IDS=123456789,987654321\n\n# Environment\nNODE_ENV=development\n```\n\n### Available Scripts\n\n```bash\npnpm run dev         # Start development server with hot reload\npnpm run build       # Build the project\npnpm start           # Start production server\npnpm run lint        # Run ESLint\npnpm run prettier    # Format code with Prettier\npnpm run seed:dev    # Seed database with admin users (development)\npnpm run seed:prod   # Seed database with admin users (production)\n```\n\n---\n\n## 🚀 Deployment\n\n### Using PM2\n\n```bash\n# Install PM2 globally\nnpm install -g pm2\n\n# Build the project\npnpm run build\n\n# Start with PM2\npm2 start dist/server.js --name \"amul-notify\"\n\n# Monitor\npm2 status\npm2 logs amul-notify\n```\n\n### Using Docker (Recommended)\n\n```bash\n# Build Docker image\ndocker build -t amul-notify .\n\n# Run container\ndocker run -d \\\n  --name amul-notify \\\n  --env-file .env.prod \\\n  -p 3000:3000 \\\n  amul-notify\n```\n\n---\n\n## � Contributing\n\nContributions are welcome! Here's how you can help:\n\n1. **Fork** the repository\n2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)\n3. **Commit** your changes (`git commit -m 'Add some amazing feature'`)\n4. **Push** to the branch (`git push origin feature/amazing-feature`)\n5. **Open** a Pull Request\n\n### Development Guidelines\n\n- Follow the existing code style and conventions\n- Add tests for new features\n- Update documentation as needed\n- Use conventional commit messages\n- Ensure all emojis use the centralized `emoji.util.ts`\n\n---\n\n## 📊 Features in Detail\n\n### Smart Stock Tracking\n\n- Monitors product availability every 5 minutes\n- Tracks inventory changes across different locations\n- Sends instant notifications when products come back in stock\n\n### Location-Based Filtering\n\n- Uses Indian pincode system for location detection\n- Shows only products available in your delivery area\n- Supports multiple substores and distribution centers\n\n### User Management\n\n- Automatic user registration on first interaction\n- Tracks user preferences and pincode settings\n- Rate limiting to prevent spam\n\n### Admin Features\n\n- Broadcast messages to all users\n- View comprehensive bot statistics\n- Monitor API sessions and performance\n\n---\n\n## 🛡️ Privacy \u0026 Disclaimer\n\n- **Privacy**: This bot only stores your Telegram user ID and chosen pincode for functionality\n- **Data Source**: All product data is fetched from the official Amul store (shop.amul.com)\n- **Unofficial**: This project is not affiliated with or endorsed by Amul\n- **Purpose**: Educational and utility project to help users track product availability\n\n---\n\n## 📜 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n## � Acknowledgments\n\n- [Amul](https://amul.com) for providing the product data through their public API\n- [Telegraf.js](https://telegraf.js.org/) for the excellent Telegram bot framework\n- All contributors and users who help improve this bot\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**Made with ❤️ by [Swapnil Soni](https://github.com/SwapnilSoni1999)**\n\n[🤖 Try the Bot](https://t.me/AmulOSSBot) • [⭐ Star on GitHub](https://github.com/SwapnilSoni1999/amul-notify) • [📞 Contact](https://t.me/SoniSins)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswapnilsoni1999%2Famul-notify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswapnilsoni1999%2Famul-notify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswapnilsoni1999%2Famul-notify/lists"}