ProfSpector

ProfSpector is a web application designed to help students find and rate professors using AI-driven recommendations. The application leverages modern web technologies and integrates with various APIs to provide a seamless and intelligent user experience.

Features

Admin Panel

• Add Professors: Easily add new professor details to the system, which automatically updates the Pinecone vector database for accurate and up-to-date AI recommendations.

User Features

• Give Feedback: Students can provide feedback and rate professors, contributing to a growing database of reviews that help other students.
• Search Within Specific Schools: Users can choose a specific school and search for professors within that school, ensuring tailored and relevant results.
• AI-Powered Recommendations: Receive personalized professor recommendations based on your preferences and academic goals.

Authentication

• Clerk Integration: Secure and seamless authentication using Clerk, ensuring that user data is protected and interactions are personalized.

Additional Features

• RAG Integration: The system uses Retrieval-Augmented Generation (RAG) to enhance the AI-driven recommendation process, ensuring that responses are both contextually relevant and informative.
• Responsive Design: Accessible on both desktop and mobile devices.
• Integration with Pinecone & OpenAI: Advanced vector search and AI-driven responses ensure relevant and accurate recommendations.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/AI-RateMyProfessor.git

2. Navigate to the project directory:

   cd AI-RateMyProfessor

3. Install the dependencies:

   npm install

Environment Variables

Before running the application, you need to set up the following environment variables in a .env file:

• OPENAI_API_KEY: Your OpenAI API key.
• PINECONE_API_KEY: Your Pinecone API key.
• NEXT_PUBLIC_CLERK_SIGN_IN_URL: URL for the sign-in page.
• NEXT_PUBLIC_CLERK_SIGN_UP_URL: URL for the sign-up page.
• NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: Your Clerk publishable key.
• CLERK_SECRET_KEY: Your Clerk secret key.
• NEXT_PUBLIC_ADMIN_EMAILS: Admin email addresses.

Steps to Get API Keys

1. OpenAI API Key:

   • Sign up or log in to OpenAI.
   • Navigate to the API section in your account dashboard.
   • Generate a new API key and set it as the OPENAI_API_KEY in your .env file.

2. Pinecone API Key:

   • Sign up or log in to Pinecone.
   • Create a new index or use an existing one.
   • Go to the API keys section and generate a new key.
   • Set this key as the PINECONE_API_KEY in your .env file.

3. Clerk API Keys:

   • Sign up or log in to Clerk.
   • Create a new application.
   • In your application's dashboard, find the publishable key and secret key.
   • Set these as NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY in your .env file.

4. Admin Emails and Password:

   • Set the NEXT_PUBLIC_ADMIN_EMAILS to the email you want to use for admin access.

Usage

1. Start the development server:

   npm run dev

2. Open your browser and navigate to:

   http://localhost:3000
   

Technologies Used

• Frontend: React, Next.js, MUI, CSS
• Backend: Node.js, Express.js
• Database: Pinecone
• Authentication: Clerk
• AI Integration: OpenAI, Pinecone
• Deployment: Vercel, AWS

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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