EduHaven is a platform designed to assist students in their academic journey by providing a productivity-focused environment. With features like task management, note-making, real-time study rooms, and a social touch, it aims to simplify and enhance the learning process. The project is built with the MERN stack and incorporates real-time collaboration, analytics, and optional AI-powered tools.
- User Dashboard: Tracks tasks completed, study time, and productivity stats.
- To-Do List: Helps users organize and manage their tasks efficiently.
- Note-Making: Rich-text editor to create, edit, and organize notes.
- Real-Time Study Rooms:
- Chat and collaborate with friends.
- Video/audio controls using WebRTC.
- Chatbot: Provides productivity tips and answers academic questions.
- Friends and Social Features: Add friends, invite them to study rooms, and track their online/offline status.
- Analytics: Visualize progress with charts and insights.
- Gamification: Earn badges and track streaks to stay motivated.
- Frontend: React.js with CSS (or Tailwind CSS)
- Backend: Node.js with Express
- Database: MongoDB
- Real-Time Communication: Socket.IO
- AI (Optional): OpenAI API for chatbot and note summarization
- Node.js
- MongoDB
- Git
-
Clone the repository:
git clone https://github.com/<your-username>/EduHaven.git cd EduHaven
-
Install dependencies:
# Install backend dependencies cd Server npm install # Install frontend dependencies cd ../Client npm install
- Start the development servers:
# Start backend server cd Server npm start # Start frontend server cd ../frontend npm run dev
- You must get assigned to the issue so others know you're working on it. leave comment to get issue assigned.
- Code must be properly formatted. (use preetier)
- Commits should generally be minimal
- The body of the commit message should explain why and how the change was made.It should provide context and motivation that will help both a reviewer now, and a developer looking at your changes a year later, understand the motivation behind your decisions.
We welcome contributions to make EduHaven better for students everywhere! Here’s how you can contribute:
- Fork the repository.
- Create a new branch for your feature/bugfix:
git checkout -b feature-name
- Make your changes and test them thoroughly.
- Commit and push your changes:
git add . git commit -m "Add a brief description of your changes" git push origin feature-name
- Create a Pull Request (PR) with a detailed explanation of your changes.
- Phase 1: Core features - User authentication, to-do list, note-making.
- Phase 2: Real-time study rooms, chatbot integration, and social features.
- Phase 3: Analytics, gamification, and AI-powered enhancements.
- Phase 4: Mobile app development and premium features.
Please follow our blueprint of Eduhaven for the project planning.
This project is licensed under the MIT License - see the LICENSE file for details.
- Special thanks to contributors for their efforts in building EduHaven.
- Inspired by productivity tools and online collaborative platforms.
Let’s make learning fun and productive!