🌟 An intelligent AI-powered personal assistant that combines seamless voice recognition, context-aware memory, and conversational charm to enhance productivity and simplify daily tasks.
- 🚀 Installation
- 💻 Usage
- ✨ Features
- 📂 Folder Structure
- 🛠️ Tech Stack
- 🤝 Contributing
- 📜 License
- 🗺️ Roadmap
- 🙏 Acknowledgements
Ensure you have the following installed on your system:
- Node.js (v16.0.0 or higher) - Download here
- npm (v7.0.0 or higher) - Comes with Node.js
- MongoDB - Installation Guide
- Git - Download here
-
Clone the repository
git clone https://github.com/H0NEYP0T-466/NeuralMate.git cd NeuralMate -
Install frontend dependencies
npm install
-
Install backend dependencies
cd backend npm install cd ..
-
Set up environment variables
cd backend cp .env.example .env # Edit .env file with your configuration: # - MongoDB connection string # - Gemini API key # - Server port (default: 8000)
-
Start the development servers
Terminal 1 - Backend:
cd backend npm startTerminal 2 - Frontend:
npm run dev
-
Open your browser
Navigate to
http://localhost:5173to start using NeuralMate!
-
Voice Commands: Click the microphone button and speak naturally
"Hello Isabella, how are you today?" "Can you help me organize my tasks?" "Review my latest project files" -
Text Input: Type your messages in the chat interface
Type: "What's the weather like?" Type: "Help me with my coding project" -
Project Analysis: Upload files or share code snippets for AI-driven feedback
Upload: project.zip Share: GitHub repository link
- Context Awareness: NeuralMate remembers your conversation history
- Multi-language Support: Communicate in your preferred language
- Task Automation: Set up recurring tasks and reminders
- Voice Synthesis: Listen to responses with natural speech
# Start a conversation
User: "Hey Isabella, I need help planning my day"
NeuralMate: "Good morning! I'd be happy to help you plan your day..."
# Get project feedback
User: "Can you review this React component?"
NeuralMate: "I'll analyze your code. Please share the component..."
# Set reminders
User: "Remind me to call mom at 6 PM"
NeuralMate: "I've set a reminder for 6 PM to call mom..."- 🎙️ Voice Recognition - Natural speech input using Web Speech API
- 🧠 Context-Aware Memory - Remembers preferences and conversation history
- ⚡ Real-Time Responses - Lightning-fast AI-powered replies
- 🔄 Task Automation - Automate repetitive tasks and workflows
- 🛠️ Code Review - AI-driven project analysis and feedback
- 🌟 Intuitive UI - Clean, responsive design for all devices
- 🌍 Multi-language - Support for multiple languages
- 💾 Persistent Storage - MongoDB-backed conversation history
- 🔊 Speech Synthesis - Natural voice responses
- 📱 Cross-Platform - Works on desktop and mobile browsers
NeuralMate/
├── backend/ # Backend server implementation
│ ├── config/ # Configuration and database setup
│ │ ├── DB.js # MongoDB connection configuration
│ │ └── saveMessages.js # Message persistence utilities
│ ├── controller/ # API route handlers and business logic
│ │ └── controller.js # Main application controller
│ ├── gemini/ # AI model integration layer
│ │ └── ai.model.js # Gemini API integration and prompts
│ ├── model/ # Database schemas and models
│ │ └── user.model.js # User and message data models
│ ├── .gitignore # Backend-specific ignore patterns
│ ├── index.js # Express server entry point
│ ├── package.json # Backend dependencies and scripts
│ └── package-lock.json # Backend dependency lock file
├── public/ # Static assets and resources
│ ├── assets/ # SVG icons and graphics
│ │ └── react.svg # React logo
│ ├── pic.jpg # Application icon/avatar
│ └── vite.svg # Vite logo
├── src/ # Frontend React application
│ ├── App.css # Main application styles
│ ├── App.jsx # Root React component
│ ├── index.css # Global CSS styles and variables
│ └── main.jsx # React application entry point
├── .gitignore # Project-wide ignore patterns
├── README.md # Project documentation (this file)
├── eslint.config.js # ESLint configuration and rules
├── index.html # HTML template and metadata
├── package.json # Frontend dependencies and scripts
├── package-lock.json # Frontend dependency lock file
└── vite.config.js # Vite build tool configuration
- React (v19.1.1) - Modern UI library with hooks and context
- Vite (v7.1.0) - Lightning-fast build tool and dev server
- React Markdown - Rich text rendering for AI responses
- Axios - HTTP client for API communication
- Web Speech API - Browser-native voice recognition
- Node.js - JavaScript runtime for server-side development
- Express.js (v5.1.0) - Minimal and flexible web application framework
- MongoDB - NoSQL database for scalable data storage
- Mongoose (v8.17.1) - MongoDB object modeling for Node.js
- Google Gemini API - Advanced language model for intelligent responses
- Web Speech API - Cross-platform speech recognition
- MyMemory Translation API - Multi-language support
- ESLint - Code linting and quality enforcement
- Git - Version control and collaboration
- npm - Package management and script execution
We welcome contributions from developers of all skill levels! Here's how you can help make NeuralMate even better:
- Fork the repository on GitHub
- Clone your fork locally
git clone https://github.com/your-username/NeuralMate.git
- Create a feature branch
git checkout -b feature/amazing-new-feature
- Make your changes and commit them
git commit -m "Add amazing new feature" - Push to your fork
git push origin feature/amazing-new-feature
- Open a Pull Request with a clear description
- 🐛 Bug Reports: Use the issue template and provide detailed reproduction steps
- ✨ Feature Requests: Clearly describe the problem and proposed solution
- 📝 Documentation: Help improve our docs and code comments
- 🧪 Testing: Add tests for new features and bug fixes
- 🎨 UI/UX: Enhance the user interface and experience
- Follow the existing ESLint configuration
- Use meaningful variable and function names
- Add comments for complex logic
- Keep functions small and focused
This project is licensed under the MIT License - see the LICENSE file for details.
MIT License
Copyright (c) 2024 NeuralMate Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
- 📅 Calendar Integration - Google Calendar and Outlook sync
- 🌍 Enhanced Multi-language - Support for 20+ languages
- 📱 Mobile App - React Native companion app
- ⏰ Smart Reminders - Context-aware notification system
- 🐞 Code Debugging - Automated bug detection and fixes
- 🎨 Theme Customization - Dark mode and custom themes
- 📴 Offline Mode - Local AI processing capabilities
- 🔌 Plugin System - Third-party integrations and extensions
- 🤖 Advanced AI - Multi-modal AI with image and document analysis
- 🏠 Smart Home Integration - IoT device control
- 🧠 Predictive Analytics - Proactive task suggestions
- 🌐 Enterprise Edition - Team collaboration features
We're grateful to the amazing open-source community and the following projects that make NeuralMate possible:
- 🚀 React Team - For the incredible UI library
- ⚡ Vite - For the blazing-fast build tool
- 🤖 Google AI - For the powerful Gemini API
- 💚 MongoDB - For the flexible database solution
- 🔧 Express.js - For the robust web framework
- 📝 React Markdown - For beautiful text rendering
- 🎯 Axios - For reliable HTTP requests
- 💡 All Contributors - Everyone who has contributed code, ideas, or feedback
- 🐛 Bug Reporters - Helping us improve and fix issues
- 📖 Documentation Writers - Making the project accessible to everyone
- ⭐ Stargazers - Your support motivates us to keep building
Made with ❤️ by H0NEYP0T-466