{"id":21367641,"url":"https://github.com/mirvald-space/polishdom_bot","last_synced_at":"2025-03-16T08:11:31.712Z","repository":{"id":254502039,"uuid":"807316649","full_name":"mirvald-space/polishdom_bot","owner":"mirvald-space","description":"PolishDom Bot is a multifunctional Telegram bot designed to help users learn the Polish language and prepare for obtaining the Karta Polaka (Polish Card).","archived":false,"fork":false,"pushed_at":"2025-03-14T05:59:13.000Z","size":293,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T06:30:10.353Z","etag":null,"topics":["aiogram","bot","language","online-learning","polish","polski","telegram-bot","tutoring"],"latest_commit_sha":null,"homepage":"https://t.me/polishdom_bot","language":"Python","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/mirvald-space.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}},"created_at":"2024-05-28T21:44:06.000Z","updated_at":"2025-03-14T05:59:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"eb8ae2c4-4541-4883-bef7-13713b876730","html_url":"https://github.com/mirvald-space/polishdom_bot","commit_stats":null,"previous_names":["mirvald-space/polishdom_bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirvald-space%2Fpolishdom_bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirvald-space%2Fpolishdom_bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirvald-space%2Fpolishdom_bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirvald-space%2Fpolishdom_bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mirvald-space","download_url":"https://codeload.github.com/mirvald-space/polishdom_bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243841222,"owners_count":20356446,"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","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":["aiogram","bot","language","online-learning","polish","polski","telegram-bot","tutoring"],"created_at":"2024-11-22T07:19:58.882Z","updated_at":"2025-03-16T08:11:31.699Z","avatar_url":"https://github.com/mirvald-space.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PolishDom Bot 🤖\n\nTelegram bot designed to help users prepare for Polish citizenship and Karta Polaka (Polish Card) interviews. The bot provides an interactive learning experience with AI-powered interview simulations and Polish language testing.\n\n## Key Features\n\n- 🎯 **AI-Powered Virtual Consul for Karta Polaka Preparation**:\n  - Simulates real interviews with a virtual Polish consul\n  - Generates dynamic questions based on typical Karta Polaka interview topics\n  - Provides instant and detailed feedback on user responses\n  - Offers personalized recommendations for interview success\n\n- 📚 **Polish Language Level Test**:\n  - Comprehensive 36-question test to determine Polish language proficiency (A1-B2)\n  - Multiple choice and translation questions\n  - Detailed explanations for each answer\n  - Progress tracking and performance analytics\n\n- 🤖 **Interview Management System**:\n  - Automated interview scheduling\n  - Real-time feedback collection\n  - Performance tracking and progress monitoring\n  - Detailed evaluation reports\n\n- 📊 **Database Integration**:\n  - MongoDB for storing user progress and test results\n  - Efficient data retrieval and management\n  - User statistics and performance tracking\n\n## Tech Stack\n\n- Python 3.x\n- aiogram 3.6.0\n- MongoDB\n- OpenAI API\n- aiohttp\n- APScheduler\n- loguru\n\n## Project Structure\n\n```\npolishdom_bot/\n├── bot.py              # Main bot file\n├── config.py           # Configuration settings\n├── db.py              # Database operations\n├── handlers/          # Message handlers\n│   ├── handlers.py    # General command handlers\n│   ├── interview.py   # Interview simulation handlers\n│   └── test.py        # Language test handlers\n├── keyboards/         # Custom keyboards\n├── services/          # Business logic\n├── requirements.txt   # Dependencies\n└── .env              # Environment variables\n```\n\n## Setup\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/yourusername/polishdom_bot.git\ncd polishdom_bot\n```\n\n2. Create and activate virtual environment:\n```bash\npython -m venv .myenv\nsource .myenv/bin/activate  # On Windows: .myenv\\Scripts\\activate\n```\n\n3. Install dependencies:\n```bash\npip install -r requirements.txt\n```\n\n4. Create `.env` file:\n```bash\ncp .env_example .env\n```\n\n5. Configure your `.env` file with the following variables:\n- `BOT_TOKEN`: Your Telegram bot token from @BotFather\n- `WEBHOOK_HOST`: Your domain or ngrok URL\n- `WEBHOOK_PATH`: Path for webhook (default: /bot)\n- `OPENAI_API_KEY`: Your OpenAI API key\n- `CHANNEL_ID`: Your Telegram channel ID\n- `MONGO_URI`: MongoDB connection string\n- `MONGO_DB_NAME`: Database name\n- `MONGO_COLLECTION_NAME`: Collection name\n- `TIMEZONE`: Your timezone (default: Asia/Tehran)\n- `DEBUG`: Debug mode (True/False)\n\n## Running the Bot\n\n1. Start the bot:\n```bash\npython bot.py\n```\n\n2. For development with ngrok:\n```bash\nngrok http 8000\n```\n\n## Features in Detail\n\n### Interview Simulation\n- AI-powered virtual consul for Karta Polaka preparation\n- Dynamic question generation based on interview topics\n- Real-time feedback and evaluation\n- Performance tracking and progress monitoring\n- Detailed evaluation reports with recommendations\n\n### Language Testing\n- Comprehensive Polish language proficiency test\n- Multiple difficulty levels (A1-B2)\n- Multiple choice and translation questions\n- Detailed explanations for each answer\n- Progress tracking and performance analytics\n\n### Database Operations\n- MongoDB integration for data persistence\n- User progress tracking\n- Test results storage\n- Performance analytics\n- Backup and recovery options\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n\n## Acknowledgments\n\n- Thanks to the aiogram team for the excellent framework\n- OpenAI for their powerful API\n- MongoDB for reliable database solutions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirvald-space%2Fpolishdom_bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmirvald-space%2Fpolishdom_bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirvald-space%2Fpolishdom_bot/lists"}