Wiseman AI Tutor - VSCode Extension Wiseman is an intelligent AI-powered programming tutor extension for Visual Studio Code that provides personalized guidance, code explanations, language conversion, and automated evaluation for programming students.

🌟 Features Core Functionality 🤖 AI-Powered Guidance: Get intelligent hints and suggestions without revealing complete solutions 📚 Code Explanation: Receive detailed explanations of code logic and programming concepts 🔄 Language Conversion: Convert code between different programming languages 📊 Automated Evaluation: Get comprehensive assessments of your programming solutions 🎯 Assignment Management: Organized workspace creation for assignments and assessments User Experience 🎨 Modern UI: Clean, conversational interface that adapts to VS Code themes ⚡ Status Bar Integration: Quick access to all Wiseman features from the status bar 🔐 Firebase Authentication: Secure login with automatic session management 🏢 Multi-Client Support: Support for multiple educational institutions 📝 Batch Management: Organized learning with batch-based assignment distribution 🚀 Installation Prerequisites Visual Studio Code 1.74.0 or higher Node.js 16.x or higher Firebase project with Firestore and Functions enabled Setup Steps Clone the repository bash git clone https://github.com/your-username/wiseman-vscode.git cd wiseman-vscode Install dependencies bash npm install Configure Firebase Update the Firebase configuration in src/extension.ts Deploy the Firebase Functions from the functions/ directory Set up Firestore with the required collections (see Data Structure below) Build the extension bash npm run compile Install the extension Press F5 to run the extension in development mode, or Package with vsce package and install the .vsix file 📋 Usage Getting Started Login: Click the Wiseman icon in the status bar and select "Login" Select Client: Choose your educational institution if you belong to multiple View Dashboard: Access your assignments and assessments from the dashboard Start Practicing: Select an assignment to create workspace files Commands Access all commands through:

Status Bar: Click the Wiseman robot icon Command Palette: Search for "Wiseman" Context Menu: Right-click in editor for code-specific actions Command Description Icon wiseman.dashboard Open the main dashboard 🏠 wiseman.login Sign in to Wiseman 🔑 wiseman.logout Sign out from Wiseman 🚪 wiseman.practice Start practice mode ▶️ wiseman.guide Get guidance on current code 💡 wiseman.explain Get code explanation 📖 wiseman.convert Convert code to another language 🔄 wiseman.evaluate Evaluate your solution ✅ AI Interactions Getting Guidance Open any code file → Select "Guide Me" → Receive hints and suggestions Code Explanation Open any code file → Select "Explain Code" → Get detailed explanations Language Conversion Open any code file → Select "Convert Code" → Choose target language → Get converted code Solution Evaluation Complete assignment → Select "Evaluate Solution" → Receive detailed feedback 🗄️ Data Structure Firestore Collections users/{userId} javascript { apiKey: "user_gemini_api_key", clients: { "client_id": { batches: ["batch1", "batch2"], settings: { default_language: "java" }, status: "active", apiKey: "client_specific_api_key" // optional } }, current_session_client: "client_id", default_client: "client_id", mobile_number: "phone_number", modelName: "gemini-2.0-flash-thinking-exp" } clients/{clientId} javascript { assessments: { "assessment_id": { config: { can_skip_questions: true, shuffle_options: true }, questions: ["question_1", "question_2"] } }, assignments: { "assignment_id": { questions: ["question_1"], tags: ["arrays", "ds"] } }, batches: { "batch_id": { assignments: { "assignment_id": { start_date: timestamp, status: "active", target_date: timestamp } }, assessments: { /* similar structure */ }, batch_name: "Batch Name", status: "active" } }, questions: { "question_id": { question_text: "Question description", type: "programming", tags: ["arrays", "programming_basics"] } } } client_config/{clientId} javascript { client_type: "college", contract_end_date: timestamp, max_licences: "1500", name: "Institution Name", plan: "plan_details" } submissions/{clientId}/{assignmentId}/{userEmail} javascript { results: { "question_id": { completeness_percentage: 90, quality_percentage: 85, correctness_percentage: 95, wiseman_comments: "Great work! Consider..." } }, submission_date: timestamp, user_email: "student@email.com", user_id: "firebase_user_id", batch_id: "batch_id", assignment_id: "assignment_id", version: 1 } ⚙️ Configuration VS Code Settings json { "wiseman.autoLogin": true, "wiseman.defaultLanguage": "java", "wiseman.showNotifications": true } Firebase Functions Environment Set these environment variables in your Firebase Functions:

Ensure proper CORS configuration Configure appropriate API quotas for Gemini API calls Set up proper security rules for Firestore 🔧 Development Project Structure wiseman-vscode/ ├── src/ │ ├── extension.ts # Main extension logic │ └── webview.html # UI interface ├── functions/ │ └── src/ │ └── index.ts # Firebase Functions ├── package.json # Extension manifest └── webpack.config.js # Build configuration Building bash

Development build with watch

npm run watch

Production build

npm run package

Run tests

npm test Firebase Functions bash cd functions npm run build firebase deploy --only functions 🎯 Key Features Explained

Intelligent Code Guidance Wiseman provides contextual hints without giving away complete solutions:

Analyzes your current code state Suggests next steps and debugging approaches Teaches problem-solving methodologies Encourages independent thinking 2. Multi-Language Code Conversion Seamlessly convert between programming languages:

Maintains logic and functionality Follows target language best practices Supports: Java, Python, JavaScript, TypeScript, C, C++, C#, Go, Rust Creates new files with proper extensions 3. Comprehensive Code Evaluation Automated assessment with detailed feedback:

Completeness: Does the code solve the entire problem? Quality: Code structure, readability, and best practices Correctness: Logic accuracy and expected output Constructive comments for improvement 4. Assignment Workspace Management Organized learning environment:

Automatic folder creation for assignments Pre-populated files with question descriptions Language-specific file extensions Comment syntax based on chosen language 5. Batch-Based Learning Structured educational experience:

Multiple batches per student Assignment and assessment separation Deadline tracking and notifications Progress monitoring across batches 🚨 Troubleshooting Common Issues

Authentication Problems Error: User must be authenticated Solution:

Check Firebase configuration Ensure proper login credentials Verify network connectivity 2. API Key Issues Error: Invalid Gemini API key Solution:

Verify API key in Firestore user document Check client-specific API key configuration Ensure API key has proper permissions 3. Assignment Loading Fails Error: Assignment not found Solution:

Verify user belongs to the correct batch Check client and batch configurations Ensure assignment exists in Firestore 4. Evaluation Timeout Error: Evaluation failed Solution:

Check code file content Verify Firebase Functions are deployed Check API quota limits Debug Mode Enable detailed logging by setting VS Code developer console:

bash

In VS Code Developer Console (Help > Toggle Developer Tools)

window.localStorage.setItem('vscode-wiseman-debug', 'true') 🔒 Security & Privacy Data Protection All code and submissions are encrypted in transit Firebase security rules protect user data API keys are securely stored in Firestore No code is stored in plain text logs Authentication Firebase Authentication with email/password Session tokens with automatic refresh Secure client-server communication Multi-client isolation Privacy Policy Code submissions are used only for evaluation No code is shared between users AI model interactions are anonymized Data retention follows educational standards 🤝 Contributing Development Setup Fork the repository Create a feature branch: git checkout -b feature/amazing-feature Make changes and test thoroughly Commit changes: git commit -m 'Add amazing feature' Push to branch: git push origin feature/amazing-feature Open a Pull Request Code Standards Use TypeScript for all new code Follow ESLint configuration Add JSDoc comments for functions Include unit tests for new features Ensure Firebase Functions pass linting Testing bash

Run all tests

npm test

Test specific functionality

npm run test:extension npm run test:functions

E2E testing

npm run test:e2e 📊 Analytics & Monitoring Usage Metrics Assignment completion rates Code evaluation scores Feature usage statistics Error tracking and resolution Performance Monitoring Firebase Functions response times Gemini API call efficiency VS Code extension load times User session analytics 🗺️ Roadmap Version 1.1 (Next Release) Offline mode support Code snippet library Peer code review features Integration with popular LMS platforms Version 1.2 (Future) Advanced analytics dashboard Custom AI model training Video tutorial integration Mobile companion app Version 2.0 (Long-term) Multi-language UI support Advanced plagiarism detection Collaborative coding sessions Industry partnership integrations 📄 License This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments Firebase team for excellent backend services Google Gemini team for powerful AI capabilities VS Code team for extensible platform Open source community for inspiration and tools 📞 Support Getting Help 📧 Email: support@wiseman-tutor.com 💬 Discord: Wiseman Community 📚 Documentation: docs.wiseman-tutor.com 🐛 Issues: GitHub Issues Educational Institutions For institutional licenses and custom deployments:

🏢 Enterprise: enterprise@wiseman-tutor.com 📋 Bulk Licensing: licensing@wiseman-tutor.com 🎓 Academic Partnerships: partnerships@wiseman-tutor.com Made with ❤️ for programming education

Empowering the next generation of developers through intelligent tutoring