Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
285 changes: 120 additions & 165 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,255 +1,210 @@
# 🚀 EduBridge

EduBridge is a **full-stack web application** that provides interactive learning resources, quizzes, and AI-driven guidance for students. It is designed to help learners explore web development, AI & ML concepts, and career opportunities through a modern, user-friendly platform.
EduBridge is a **full-stack web application** that provides interactive learning resources, quizzes, and AI-driven guidance for students. It helps learners explore **Web Development, AI/ML concepts, and career opportunities** through a modern and user-friendly platform.

---

## 📌 Project Overview
# 📌 Project Overview

EduBridge bridges the gap between learning and career guidance by combining structured educational content with AI-powered assistance. Students can:
- Learn technical topics
- Test their knowledge through quizzes
- Receive AI-powered career and learning suggestions
EduBridge bridges the gap between learning and career guidance by combining structured educational content with AI-powered assistance.

Users can:

- 📚 Learn technical topics
- 📝 Test their knowledge through quizzes
- 🤖 Receive AI-powered learning assistance
- 🎯 Explore career guidance resources

---

## ✨ Features
# ✨ Features

- 🔐 **User Authentication** – Secure login and registration system
- 👤 **Personalized Profiles** – Users can manage and update their profiles
- 🧠 **Quizzes** – Assess knowledge on various technical topics
- 🤖 **AI Assistance** – AI-powered learning and guidance
- 🎯 **Career Guidance** – Resources and career advice
- 📱 **Responsive Design** – Works across desktops, tablets, and mobile devices
- 🔐 Secure User Authentication
- 👤 Personalized User Profiles
- 🧠 Interactive Technical Quizzes
- 🤖 AI-powered Learning Assistance
- 🎯 Career Guidance Resources
- 📱 Fully Responsive Design

---

## 🛠 Technologies Used
# 🛠️ Tech Stack

## 🌐 Frontend

- HTML
- CSS
- JavaScript

## ⚙️ Backend

### 🌐 Frontend
- **HTML:** Semantic structure and accessibility
- **CSS:** Styling, layout, and responsiveness
- **JavaScript:** Interactivity and API handling
- Python
- Flask

### ⚙️ Backend
- **Python:** Core backend language
- **Flask:** Lightweight web framework
## 🤖 APIs

### 🤖 APIs
- **OpenAI API:** AI-driven features
- OpenAI API

### 🔧 Tools
- **Git:** Version control
- **GitHub:** Collaboration and project hosting
## 🔧 Tools

- Git
- GitHub

---

## 📂 Folder Structure
EduBridge/
├── backend/
│ └── app.py
├── assets/
├── styles/
├── templates/
├── auth/
├── scripts/
├── server/
├── images/
├── index.html
├── login.html
├── profile.html
├── quiz.html
├── ai.html
├── webdev.html
├── career.html
# 📂 Project Structure

```text
EduBridge/
├── backend/
│ └── app.py
└── app.py
├── assets/
├── Styles/
├── templates/
├── auth/
├── images/
├── scripts/
├── server/
├── images/
├── styles/
├── templates/
├── ai.html
├── career.html
├── index.html
├── login.html
├── profile.html
├── quiz.html
├── ai.html
├── webdev.html
├── career.html
└── register.html
├── register.html
└── webdev.html
```

---

## ⚙️ Setup Instructions
# ⚙️ Installation & Setup

## 1. Clone the Repository

1️⃣ Clone the repository
```bash
git clone https://github.com/AditixAnand/EduBridge.git
cd EduBridge
```
2️⃣ Setup Python Backend
```bash
cd backend
pip install flask python-dotenv openai
```
💡 Recommended: Use a virtual environment:
```bash
python -m venv venv
venv\Scripts\activate # Windows
source venv/bin/activate # macOS/Linux
```
3️⃣ Run the Backend
```bash
python app.py
```
4️⃣ Open the Frontend
Open index.html in your browser.
**✅ Important:**
Ensure JavaScript API calls point to:
```bash
http://127.0.0.1:5000/
git clone https://github.com/AditixAnand/EduBridge.git
cd EduBridge
```

---

## 🤝 Contribution Guidelines
1️⃣ Fork the repository
2️⃣ Create a new branch for your feature or fix
3️⃣ Work only on admin-approved issues
4️⃣ Write clean, readable, and well-documented code
5️⃣ Make meaningful commit messages
6️⃣ Submit a Pull Request with a clear description
7️⃣ Wait for Project Admin review before merge
## 2. Create a Virtual Environment (Recommended)

---
### Windows

## 🏷 Issue Management
1️⃣ Issues are created and managed by the Project Admin
2️⃣ Contributors must request issue assignment before starting work
3️⃣ One issue is assigned to one contributor at a time
4️⃣ Inactive contributors may be unassigned
5️⃣ Issues are clearly defined and achievable
```bash
python -m venv venv
venv\Scripts\activate
```

**Issue Labels Used**
- easy
- medium
- hard
- good first issue
- bug
- feature
- documentation
- help wanted
### macOS/Linux

```bash
python3 -m venv venv
source venv/bin/activate
```

---

## 🔍 Pull Request Rules
1️⃣ PRs must be linked to an assigned issue
2️⃣ Code must be original and plagiarism-free
3️⃣ Low-effort, spam, or duplicate PRs will be rejected
4️⃣ Admin may request changes before approval
5️⃣ Only merged PRs are considered valid contributions
### 1. Clone the repository
## 3. Install Dependencies

`git clone <your-repo-url>`
```bash
cd backend
pip install flask python-dotenv openai
```

cd EduBridge
---

### 2. Setup Python Backend
## 4. Run the Backend

cd backend
```bash
python app.py
```

pip install flask python-dotenv openai
The Flask server will start at:

### 3. Run the Backend
```
http://127.0.0.1:5000/
```

python app.py
---

### 4. Open Frontend
## 5. Open the Frontend

Open index.html in your browser
Open **index.html** in your browser.

### Ensure JavaScript API calls point to:
Make sure all JavaScript API requests point to:

```text
http://127.0.0.1:5000/
```

---

## 🤝 Contribution Guidelines
- Fork the repository
- Create a new branch for your feature or fix
- Work only on admin-approved issues
- Write clean, readable, and well-documented code
- Make meaningful commit messages
- Submit a Pull Request with a clear description
- Wait for Project Admin review before merge
# 🤝 Contribution Guidelines

---
Please follow these guidelines before contributing:

## 🏷 Issue Management
Issues are created and managed by the Project admin
1. Fork the repository.
2. Create a new branch.
3. Work only on issues assigned by the project admin.
4. Write clean, readable, and well-documented code.
5. Use meaningful commit messages.
6. Submit a Pull Request with a clear description.
7. Wait for project admin review before merging.

Contributors must request issue assignment before starting work
---

One issue is assigned to one contributor at a time
# 🏷️ Issue Management

Inactive contributors may be unassigned
- Issues are managed by the Project Admin.
- Contributors must request assignment before starting work.
- Only one contributor is assigned per issue.
- Inactive contributors may be unassigned.
- Issues are designed to be beginner-friendly and well-defined.

Issues are clearly defined and achievable
## Available Labels

### Issue Labels Used
- easy
- medium
- hard
- good first issue
- documentation
- bug
- feature
- documentation
- enhancement
- help wanted
- easy
- medium
- hard

---

## 🔍 Pull Request Rules
- PRs must be linked to an assigned issue
- Code must be original and plagiarism-free
- Low-effort, spam, or duplicate PRs will be rejected
- Admin may request changes before approval
- Only merged PRs are considered valid contributions
# 🔍 Pull Request Guidelines

---

## 🚀 Future Enhancements
Leaderboard system
- PRs must be linked to an assigned issue.
- Code must be original and plagiarism-free.
- Low-quality, spam, or duplicate PRs will be rejected.
- Requested changes should be addressed before approval.
- Only merged PRs count as valid contributions.

---

## 🚀 Future Enhancements
- Leaderboard system
- Advanced learning analytics
- Enhanced AI personalization
- Mobile application support
# 🚀 Future Enhancements

---
- 🏆 Leaderboard System
- 📊 Advanced Learning Analytics
- 🤖 Enhanced AI Personalization
- 📱 Mobile Application Support

---

## 📜 License
This project is licensed under the MIT License. See the LICENSE file for details.
# 📜 License

---
This project is licensed under the **MIT License**.

## 📬 Contact
- LinkedIn: Aditi Anand
- Email: aditianand09tkp@gmail.com
See the **LICENSE** file for more information.

## 📬 Contact
LinkedIn: Aditi Anand
---

Email: aditianand09tkp@gmail.com
# 📬 Contact

---
- LinkedIn: Aditi Anand
- Email: aditianand09tkp@gmail.com