BGU Scout

A Chrome extension that helps BGU students easily access and visualize course statistics and grades.

---

📚 Table of Contents

• BGU Scout
  • 📚 Table of Contents
  • 📖 Project Overview
  • 🎯 Features
  • ⚙️ Installation
    • Prerequisites
    • Option 1: Chrome Web Store (Recommended)
    • Option 2: Manual Installation (Developer Mode)
  • 🔧 Configuration
  • 📊 Usage
    • Generating Course Statistics
  • 📸 Screenshots
    • Popup Page
    • Options Page
  • 🛠️ Technical Details
    • Technologies Used
    • Features Implementation
  • 🗺️ Roadmap
  • 🔐 Privacy and Security
    • Permissions
  • 👥 Contributing
  • 📝 License
  • ❓ FAQs
    • How do I install the extension?
    • Can I use this extension on other browsers?
  • 📞 Contact

📖 Project Overview

BGU Scout is a Chrome extension designed to assist Ben-Gurion University students in accessing and visualizing course statistics and grades. The extension offers various features such as graphical representation of course data, theme switching, bilingual support, and quick access to university portals.

🎯 Features

• Course Statistics Visualization: Generate graphical representations of course statistics and grades.
• Dark/Light Mode Support: Automatic theme switching based on system preferences or manual selection.
• Color Scheme Options: Choose from multiple color themes including Blue, Green, Pink, and Purple.
• Multiple Course Displays: View multiple course distributions simultaneously with enhanced capabilities.
• Bilingual Support: Full Hebrew and English language support.
• Course Management: Save and manage multiple courses for quick access.
• Quick Access: Direct links to BGU's login portal and grade system.
• User Data Management: Securely store and manage user credentials.
• Moodle Integration: Automatically add courses from Moodle to the extension.

⚙️ Installation

Prerequisites

• Google Chrome or a Chromium-based browser, such as Edge or Opera.

Option 1: Chrome Web Store (Recommended)

1. Visit the BGU Scout extension page on the Chrome Web Store.
2. Click "Add to Chrome" to install the extension.
3. The extension icon will appear in your Chrome toolbar.

Option 2: Manual Installation (Developer Mode)

1. Clone the repository or download the ZIP file from the latest release
2. Extract the ZIP file to a directory on your computer.
3. Open Chrome and navigate to chrome://extensions/.
4. Enable "Developer mode" in the top right corner.
5. Click "Load unpacked" and select the extension directory.
6. The extension icon should now appear in your Chrome toolbar.

🔧 Configuration

1. Click the extension icon to open the popup interface.
2. Click "Options" to configure:
   • Username, Password and ID number (BGU credentials)
   • Theme preference (Light/Dark/System)
   • Color scheme options (Blue, Green, Pink, Purple)
   • Language preference (English/Hebrew/System)
   • Moodle Auto-Add Courses (On/Off)
   • Course numbers and names
3. Save your settings.
4. Use the popup interface to generate grade statistics and access BGU systems.

📊 Usage

Generating Course Statistics

1. Open the extension popup.
2. Enter the desired year span.
3. Choose the desired semesters and Exam/Quiz numbers.
4. Select the course name from the dropdown list.
5. Click the "Display" icon and wait for the data to load.
6. Enjoy the graphical representation of the course statistics.

📸 Screenshots

Popup Page

Effortlessly manage your BGU course statistics and grades with a user-friendly interface.

Options Page

Configure your extension settings and customize your experience with ease.

🛠️ Technical Details

Technologies Used

• HTML5
• CSS3 with CSS Variables for theming
• Vanilla JavaScript
• Chrome Extension APIs
  • Storage
  • Tabs
  • Content Scripts

Features Implementation

• Theme System: Uses CSS variables for consistent theming across all components.
• Localization: Built-in translation system for Hebrew and English.
• Form Validation: Server-side validation for user credentials and course numbers.
• Error Handling: Proper error messages and user feedback.
• Storage Management: Efficient use of Chrome's storage local API.

🗺️ Roadmap

• Improve security and privacy features.
• Add support for more devices and screen sizes.
• Add support for multiple course displays.
• Add more customization options (color schemes).
• Improve error handling and user feedback.
• Add support for searching courses by name.
• Improve user experience and accessibility.
• Add support for more BGU systems and services.
• Add support for more browsers and platforms.
• Add support for more data formats and standards.
• Improve performance and scalability.
• Improve documentation and code quality.

🔐 Privacy and Security

• User Data: User credentials are stored locally in Chrome's secure storage and are only used for BGU login authentication. No Private data is transmitted to external servers except for BGU's official sites during key extraction.
• Data Handling: Course statistics are fetched directly from BGU's servers and are not stored locally.
• Permissions: The extension only requests the necessary permissions for its functionality.

Permissions

The extension requires the following permissions:

• storage: For saving user preferences and course numbers.
• tabs: For opening BGU websites.

👥 Contributing

Feel free to open issues and submit pull requests. Please ensure your code follows the existing style and includes appropriate documentation.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

❓ FAQs

How do I install the extension?

You can install the extension directly from the Chrome Web Store or follow the manual installation steps in the Installation section above.

Can I use this extension on other browsers?

The extension is primarily designed for Chrome and Chromium-based browsers.

📞 Contact

For any inquiries, please contact thisisjustadeveloper@gmail.com.

---

Made with ❤️ for BGU Students