{"id":30344495,"url":"https://github.com/msparihar/dumrooai","last_synced_at":"2025-08-18T12:42:37.422Z","repository":{"id":307172493,"uuid":"1028602362","full_name":"Msparihar/dumrooai","owner":"Msparihar","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-29T19:22:51.000Z","size":1706,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-29T21:54:02.124Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/Msparihar.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-07-29T19:20:33.000Z","updated_at":"2025-07-29T19:22:54.000Z","dependencies_parsed_at":"2025-07-29T21:54:09.226Z","dependency_job_id":"4b1a45f7-2bc6-4570-ba15-8af6cebda6f9","html_url":"https://github.com/Msparihar/dumrooai","commit_stats":null,"previous_names":["msparihar/dumrooai"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/Msparihar/dumrooai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fdumrooai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fdumrooai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fdumrooai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fdumrooai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Msparihar","download_url":"https://codeload.github.com/Msparihar/dumrooai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fdumrooai/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270996250,"owners_count":24681933,"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-08-18T02:00:08.743Z","response_time":89,"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":[],"created_at":"2025-08-18T12:42:35.655Z","updated_at":"2025-08-18T12:42:37.371Z","avatar_url":"https://github.com/Msparihar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🤖 Dumroo.ai Admin Chatbot\n\n**AI-powered student data analytics with role-based access control**\n\n## 🎬 Demo Video\n\n![Demo](https://www.loom.com/share/52498750f0fc4a89bbe5dcf6669429c7?sid=76d7c7ed-7f13-4836-8d78-b7cf9ff5e0fc)\n\n*👆 Watch the full demo of the Dumroo.ai Admin Chatbot*\n\n---\n\n## 🚀 Quick Start\n\nGet up and running in 3 simple steps:\n\n```bash\n# 1. Clone the repository\ngit clone \u003cyour-repo-url\u003e\ncd dumrooai\n\n# 2. Configure environment\ncp .env.example .env\n# Edit .env and add your OpenAI API key\n\n# 3. Run with Docker\ndocker compose up --build\n```\n\n**🌐 Open your browser and go to:** `http://localhost:8000`\n\n---\n\n## ✨ Features\n\n- **🔐 Role-Based Access Control**: Different users see different data based on their role\n- **💬 Real-time Chat Interface**: WebSocket-powered AI conversations\n- **📊 Beautiful Data Visualization**: Markdown tables with proper formatting\n- **🎨 Modern UI**: Clean, responsive interface with loading animations\n- **🐳 Docker Ready**: One-command deployment\n- **🤖 OpenAI Integration**: Powered by GPT-4o-mini for intelligent responses\n\n---\n\n## 👥 User Roles \u0026 Access\n\n### 🧑‍🏫 Grade 8 Teacher (amit_sharma)\n\n- **Access**: All Grade 8 students across sections A \u0026 B\n- **Data**: 24+ student records from North, South, East, West regions\n- **Use Cases**: Grade-level performance analysis, cross-section comparisons\n\n### 🏢 South Region Administrator (priya_singh)\n\n- **Access**: All students from South region schools\n- **Data**: 18+ student records across grades 8, 9, 10\n- **Use Cases**: Regional performance tracking, multi-grade insights\n\n### 👨‍🏫 Class 10-C Teacher (raj_kumar)\n\n- **Access**: Only Class 10-C students\n- **Data**: 6+ specific class records\n- **Use Cases**: Class-specific assignments, individual student tracking\n\n---\n\n## 🛠️ Setup Instructions\n\n### Prerequisites\n\n- Docker \u0026 Docker Compose\n- OpenAI API Key ([Get one here](https://platform.openai.com/api-keys))\n\n### Environment Configuration\n\n1. **Copy the environment template:**\n\n   ```bash\n   cp .env.example .env\n   ```\n\n2. **Edit `.env` with your API key:**\n\n   ```env\n   OPENAI_API_KEY=sk-your-actual-openai-api-key-here\n   SECRET_KEY=your_super_secret_jwt_key_here\n   ALGORITHM=HS256\n   ```\n\n3. **Launch the application:**\n\n   ```bash\n   docker compose up --build\n   ```\n\n### Accessing the Application\n\n- **Web Interface**: \u003chttp://localhost:8000\u003e\n- **API Documentation**: \u003chttp://localhost:8000/docs\u003e (FastAPI auto-generated)\n\n---\n\n## 🎯 Try These Sample Queries\n\nOnce logged in, try asking:\n\n- *\"Show me all submitted assignments from last week\"*\n- *\"Which students have pending assignments?\"*\n- *\"What are the upcoming scheduled assignments?\"*\n- *\"Show me student performance in Math subjects\"*\n- *\"Who scored above 90% this week?\"*\n\n---\n\n## 🏗️ Architecture\n\n```\n┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐\n│   Frontend      │    │    FastAPI       │    │   OpenAI API    │\n│   (HTML/JS)     │◄──►│   Backend        │◄──►│   (GPT-4o)      │\n│                 │    │                  │    │                 │\n│ • Login UI      │    │ • JWT Auth       │    │ • Tool Calling  │\n│ • Chat Interface│    │ • WebSocket      │    │ • Data Analysis │\n│ • Markdown      │    │ • RBAC           │    │ • Formatting    │\n└─────────────────┘    └──────────────────┘    └─────────────────┘\n                                │\n                                ▼\n                       ┌──────────────────┐\n                       │   Student Data   │\n                       │     (CSV)        │\n                       │                  │\n                       │ • 72 Records     │\n                       │ • 60 Students    │\n                       │ • 20+ Subjects   │\n                       └──────────────────┘\n```\n\n## 🧬 Technology Stack\n\n- **Backend**: FastAPI, Python 3.12\n- **Frontend**: Vanilla JavaScript, HTML5, CSS3\n- **AI**: OpenAI GPT-4o-mini with function calling\n- **Authentication**: JWT tokens\n- **WebSocket**: Real-time bidirectional communication\n- **Containerization**: Docker \u0026 Docker Compose\n- **Data**: CSV with 72 realistic student records\n\n---\n\n## 📊 Dataset Overview\n\nThe included dataset contains:\n\n- **60 unique students** with realistic names\n- **72 assignment records** across multiple subjects\n- **Subjects**: Math, Science, History, English, Physics, Chemistry, Biology, Art, Music, Languages\n- **Score Range**: 76-96% (realistic distribution)\n- **Statuses**: Submitted (50), Scheduled (10), Pending (12)\n- **Regions**: North, South, East, West (balanced)\n- **Grades**: 8, 9, 10 with proper distribution\n\n---\n\n## 🔒 Security Features\n\n- **JWT Authentication**: Secure token-based auth\n- **Role-Based Access Control**: Data isolation by user role\n- **Input Sanitization**: XSS protection\n- **Environment Variables**: Secure API key management\n- **CORS Configuration**: Controlled cross-origin requests\n\n---\n\n## 🐳 Docker Configuration\n\nThe project includes optimized Docker setup:\n\n- **Multi-stage builds** with UV package manager\n- **Environment variable** injection\n- **Volume mounting** for data persistence\n- **Health checks** and proper logging\n- **Production-ready** configuration\n\n---\n\n## 🚀 Development\n\n### Local Development (without Docker)\n\n```bash\n# Install dependencies\nuv sync\n\n# Set up environment\ncp .env.example .env\n# Edit .env with your API key\n\n# Run development server\nuv run fastapi run main.py --reload\n\n# Open browser\nopen http://localhost:8000\n```\n\n### Project Structure\n\n```\ndumrooai/\n├── main.py              # FastAPI application\n├── index.html           # Frontend interface\n├── student_data.csv     # Sample dataset\n├── docker-compose.yml   # Docker configuration\n├── Dockerfile          # Container definition\n├── .env.example        # Environment template\n├── pyproject.toml      # Python dependencies\n└── README.md           # This file\n```\n\n---\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\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## 📞 Support\n\nIf you encounter any issues:\n\n1. Check the [Issues](../../issues) page\n2. Review the demo video above\n3. Ensure your OpenAI API key is valid\n4. Verify Docker is running properly\n\n---\n\n## 🙏 Acknowledgments\n\n- **OpenAI** for the powerful GPT-4o-mini model\n- **FastAPI** for the excellent web framework\n- **Docker** for containerization\n- **Marked.js** for markdown rendering\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**Built with ❤️ for educational data analytics**\n\n⭐ **If this project helped you, please give it a star!** ⭐\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsparihar%2Fdumrooai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsparihar%2Fdumrooai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsparihar%2Fdumrooai/lists"}