Skip to content

codingburgas/2425-11-g-pp-student-practices-assignment-gradeup

Repository files navigation

🎓 GradeUp - School Recommendation System

GradeUp

A web application that helps students find the perfect educational institution based on their preferences and needs.


📑 Table of Contents


📸 Preview

Take a quick look at Grade Up in action:

Home Screen
Home Screen
Welcome Screen
Welcome Back Page
Dashboard
Dashboard
Survey
Survey

🛠️ Contributors

Backend 👨‍💻

KRRusev21 | TPIvanov21

Designers 🎨

PSDineva21 | GYFilipov21

Scrum Master 🧑‍🏫

SGMikov21


🚀 Features

  • 🔐User authentication (registration, login, profile management)
  • 🎓Student dashboard with personalized recommendations
  • 🛠️ Admin panel for user and system management
  • 🏫 School and program browsing
  • 📊 Comprehensive progress tracking and analytics

You can view the full list of user stories HERE.


🔧 Configuration Options

  • Email Verification Toggle - You can disable email verification by setting DISABLE_EMAIL_VERIFICATION=true in your .env file
  • Recommendation Engine - Enhanced algorithm provides personalized university and program recommendations
  • Database Configuration - Supports both SQLite for development and SQL Server for production

🚀 AI Module Integration (Quick Summary)

  • Two main modules:

    • AdvancedPredictionSystem: Predictions with confidence scoring.
    • RecommendationEngine: Program & university recommendations.
  • Integrated directly into Flask backend.

  • Uses SQLAlchemy models: User, Program, School, SurveyResponse, etc.

  • API routes call modules:

    • /api/predictpredict_with_confidence()
    • /api/recommendrecommend_programs()
  • Frontend sends survey data → Backend processes → Returns predictions → Displayed to user.

  • Results stored in DB: PredictionHistory, Recommendation.


🖼 System Flowchart

System Flowchart

🛠️ Installation

  1. Clone the repository:

    git clone https://github.com/your-username/school-recommendation-system.git
    cd school-recommendation-system
  2. Create a virtual environment (Python 3.12 is recommended!):

    python -m venv venv
  3. Activate the virtual environment:

    • Windows:
      venv\Scripts\activate
    • MacOS/Linux:
      source venv/bin/activate
  4. Install dependencies:

    pip install -r requirements.txt
  5. Set up environment variables:
    Create a .env file and configure your environment settings.

  6. Initialize the database:

    flask db upgrade
  7. Run the application:

    flask run

🧩 Entity Relationship Diagram (ERD)

You can view the ERD for this project here:

👉 View ER Diagram For GradeUp HERE


🧩 Class Diagram

You can view the Class Diagram for this project here:

👉 View Class Diagram For GradeUp HERE


🧩 Use Case Diagram

You can view the Use Case Diagram for this project here:

👉 View Use Case Diagram For GradeUp HERE


💻 Technology Stack

  • Flask – Web framework
  • SQLAlchemy – ORM for database operations
  • Flask-Login – User session management
  • Bootstrap – Frontend UI framework
  • SQL Server – Configurable backend database

About

2425-11-g-pp-student-practices-assignment-gradeup created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6