diff --git a/README.md b/README.md index 19aac8f..16a5fea 100644 --- a/README.md +++ b/README.md @@ -1 +1,53 @@ -# HackX Entry By FreeBug +# eduConnect by Team freeBug + +Welcome to eduConnect, a revolutionary platform where users can gain and share knowledge in specific domains. eduConnect offers a seamless experience for users to learn, interact, and grow in their areas of interest. Whether you're an expert wanting to share your insights or a learner eager to explore, eduConnect has you covered. + + + +## πŸš€ Features + +### πŸ” User Authentication +- Register and Login: Secure authentication system for users to create accounts and access their personalized dashboard. + +### πŸ“š Knowledge Sharing +- Create Courses: Share your expertise by creating courses in specific domains. +- Enroll in Courses: Explore and enroll in various courses to enhance your knowledge. + +### πŸ’¬ Interactive Learning +- Chat Rooms: Each course has its own chat room, enabling students and instructors to interact and discuss. +- Spam Prevention: Robust measures to prevent spam messages in chat rooms, ensuring meaningful conversations. + +### 🧠 Personalized Quizzes +- Identical Quizzes: Based on a user’s read history, tailored quizzes are provided to reinforce learning and retention. + +### πŸ“Š Progress Tracking +- Activity Log: Users can keep track of their progress, monitor their activities, and evaluate how much they’ve learned. +- Knowledge Metrics: Insights into user performance and course engagement. + +### πŸŽ–οΈ Badges & Rewards +- User Badges: Earn badges for achievements to stay motivated and energized while learning. + + + +## πŸ› οΈ Tech Stack +- Backend: Python, Flask +- Frontend: HTML, CSS, JavaScript +- Database: PostgreSQL/MySQL +- Authentication: JWT-based secure authentication +- Hosting: AWS/Heroku/Your Hosting Solution + + + +## πŸ“„ Installation Guide + +### Prerequisites +1. Python 3.8+ installed on your system. +2. PostgreSQL/MySQL database setup. +3. Node.js and npm (if applicable for frontend). +4. A virtual environment for Python dependencies. + +### Steps +1. Clone the Repository + bash + git clone https://github.com/your-username/eduConnect.git + cd eduConnect