A powerful AI-powered student companion application built with Node.js and Java, designed to enhance learning and productivity.
- Real-time chat with AI assistant
- Seamless integration with Ollama's language models
- WebSocket-based .communication
- Clean, modern architecture
- Cross-platform compatibility
- Backend: Node.js, Express, WebSocket
- AI Integration: Ollama
- Build Tools: npm, Maven
- Version Control: Git
- Node.js 16+
- Java 11+
- Ollama server running locally
- npm or yarn
-
Clone the repository
git clone https://github.com/yourusername/ai-student-companion.git cd ai-student-companion -
Install dependencies
# Install Node.js dependencies npm install # Install Java dependencies mvn install
-
Start the backend server
node server.js
-
Start the frontend (in a new terminal)
cd frontend npm install npm start -
Access the application
- Frontend: http://localhost:3000
- Backend API: http://localhost:3002
Create a .env file in the root directory with the following variables:
PORT=3002
OLLAMA_URL=http://localhost:11434
MODEL=llama3.2:1b- Fork the repository
- Create a new branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Ollama for the powerful AI models
- All contributors who have helped shape this project A smart AI assistant for students