Boiler Schedulings

Introduction

Boiler Schedulings is a cutting-edge web application designed to transform the way students plan their academic schedules. Leveraging an AI-driven conversational interface, this tool combines a Retrieval Augmented Generation (RAG) system with vector databases to offer personalized and interactive scheduling solutions. Its primary goal is to simplify and optimize academic planning, making it a stress-free and efficient experience for students.

Features

• AI-Powered Chat Interface: Engage in natural conversations with our AI to plan your schedule.
• Dynamic Widgets: Visualize your schedule with interactive widgets displaying class recommendations, professor ratings, and course insights.
• Real-Time Updates: Get instant recommendations and schedule adjustments based on your preferences and academic requirements.

Technology Stack

• Front-End: React.js for a responsive and dynamic user interface.
• Back-End: Node.js/Python for server-side logic.
• Database: Firebase Realtime Database for storing user data and chat history.
• Authentication: Firebase Authentication for secure user access.
• AI and Data Handling: RAG system integrated with vector databases for intelligent response generation.

Installation

1. Clone the GitHub repository
2. Navigate to the project directory
3. Install the necessary dependencies
4. Set up Firebase:
   • Create a new Firebase project in the Firebase Console.
   • Enable Realtime Database and Authentication in your Firebase project.
   • Add your Firebase project configuration to a .env file at the root of the project:

     REACT_APP_FIREBASE_API_KEY=your_api_key
     REACT_APP_FIREBASE_AUTH_DOMAIN=your_project_id.firebaseapp.com
     REACT_APP_FIREBASE_DATABASE_URL=https://your_project_id.firebaseio.com
     REACT_APP_FIREBASE_PROJECT_ID=your_project_id
     REACT_APP_FIREBASE_STORAGE_BUCKET=your_project_id.appspot.com
     REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
     REACT_APP_FIREBASE_APP_ID=your_app_id
     

Running the Application

1. Start the application locally:

   npm run dev

2. Access the application at http://localhost:5173.

Usage

After launching Boiler Schedulings, log in using Google credentials. The AI chat interface will greet you, prompting you to start discussing your scheduling needs. You can ask questions or provide information about your preferred courses, timings, and professors. The AI will use this information to generate a personalized schedule, displayed in dynamic widgets. Interact with these widgets to refine your schedule, view professor ratings, and get detailed course descriptions.