https://github.com/sabsar42/rate-my-professor-ai-rag
Rate My Professor AI (RAG) is an innovative chat interface that helps students find information about professors using artificial intelligence. This project combines a sleek, modern UI with powerful AI capabilities to provide students with quick, insightful information about their potential instructors.
https://github.com/sabsar42/rate-my-professor-ai-rag
embeddings gemini-api javascript langchain llm nextjs vectordb
Last synced: 4 months ago
JSON representation
Rate My Professor AI (RAG) is an innovative chat interface that helps students find information about professors using artificial intelligence. This project combines a sleek, modern UI with powerful AI capabilities to provide students with quick, insightful information about their potential instructors.
- Host: GitHub
- URL: https://github.com/sabsar42/rate-my-professor-ai-rag
- Owner: sabsar42
- Created: 2024-08-28T17:34:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-01T14:46:29.000Z (about 1 year ago)
- Last Synced: 2025-04-07T11:48:08.295Z (6 months ago)
- Topics: embeddings, gemini-api, javascript, langchain, llm, nextjs, vectordb
- Language: Jupyter Notebook
- Homepage: https://github.com/sabsar42/Rate-My-Professor-AI-RAG
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rate My Professor AI (RAG)
## Overview
Rate My Professor AI (RAG) is an innovative chat interface that helps students find information about professors using artificial intelligence. This project combines a sleek, modern UI with powerful AI capabilities to provide students with quick, insightful information about their potential instructors.
## Features
- **AI-Powered Responses**: Get detailed information about professors based on your queries.
- **Modern UI**: A photomorphic design with a purple gradient background for an engaging user experience.
- **Real-time Chat**: Instantly send messages and receive AI-generated responses.
- **Responsive Design**: Works seamlessly on desktop and mobile devices.
## Technologies Used
- React
- Next.js
- Material-UI (MUI)
- Pinecode
- Google's Gemini
- Langchain
## Prerequisites
Before you begin, ensure you have the following installed:
- Node.js (v14 or later)
- npm (v6 or later)
## Installation
1. Clone the repository:
```
git clone https://github.com/sabsar42/Rate-My-Professor-AI-RAG.git
```
2. Navigate to the project directory:
```
cd Rate-My-Professor-AI-RAG
```
3. Install the dependencies:
```
npm install
```
## Configuration
1. Create a `.env.local` file in the root directory.
2. Add your AI service API key:
```
AI_API_KEY=your_api_key_here
```
## Running the Application
1. Start the development server:
```
npm run dev
```
2. Open your browser and navigate to `http://localhost:3000`.
## Usage
1. Type your query about a professor in the chat input.
2. Press the "Send" button or hit Enter to submit your question.
3. The AI will process your query and provide a response with relevant information about the professor.
## Contributing
We welcome contributions to the Rate My Professor AI project. Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch for your feature (`git checkout -b feature/Feature`).
3. Commit your changes (`git commit -m 'Add some Feature'`).
4. Push to the branch (`git push origin feature/Feature`).
5. Open a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
- Headstarter AI
## Contact
Name: Shakib Absar
Project Link: [https://github.com/sabsar42/Rate-My-Professor-AI-RAG](https://github.com/sabsar42/Rate-My-Professor-AI-RAG)