Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suraj-kumar00/gurunimbus
Building GuruNimbus an advanced AI-powered RAG chatbot that intelligently guides you in rating and discovering the best professors.
https://github.com/suraj-kumar00/gurunimbus
ai-rag-chatbot ai-rate-my-professor artificial-intelligence devops github-actions gurunimbus nextjs14 openai pinecone python rag
Last synced: 16 days ago
JSON representation
Building GuruNimbus an advanced AI-powered RAG chatbot that intelligently guides you in rating and discovering the best professors.
- Host: GitHub
- URL: https://github.com/suraj-kumar00/gurunimbus
- Owner: Suraj-kumar00
- License: apache-2.0
- Created: 2024-08-21T18:49:59.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T12:41:45.000Z (4 months ago)
- Last Synced: 2024-08-30T04:59:17.379Z (4 months ago)
- Topics: ai-rag-chatbot, ai-rate-my-professor, artificial-intelligence, devops, github-actions, gurunimbus, nextjs14, openai, pinecone, python, rag
- Language: TypeScript
- Homepage: https://guru-nimbus.vercel.app
- Size: 1.61 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**"GuruNimbus: RAG-Powered AI Assistant"** is a web app that uses Next.js, OpenAI, and Pinecone to deliver personalized professor and mentor insights. It goes beyond conventional rating systems by leveraging AI to offer detailed evaluations, helping students make informed decisions about their courses and instructors.
## Features
1. **Rate My Professor Support Agent with RAG-Powered AI Capabilities**
2. **Web Scraping Integration**
3. **Advanced Search option to find Professors**
## Tech Stack
- NextJs
- Typescript
- Jupyter Notebook
- Python
- Pinecone
- OpenAI
## For APIs
- Openrouter API Key
- Gemini API Key
## DevOps Practices
- CI/CD with GitHub Actions
- Dockerization
## Project Workflow
### Installation for local development:
1. Download [**Miniconda**](https://docs.anaconda.com/miniconda/) of your system.
2. [fork the reqpository](https://github.com/Suraj-kumar00/GuruNimbus/fork)
```bash
# Install Next.js package dependencies
npm install
# Create a new Conda environment named 'rag' with Python 3.10.4
conda create --name rag python=3.10.4
# Activate the 'rag' environment
conda activate rag
# To install all package/dependencies in one signle commands:
pip install -r requirements.txt
# Install the python-dotenv package for managing environment variables
pip install python-dotenv
# Install the Pinecone client library with gRPC support
pip install "pinecone-client[grpc]"
# Deactivate the current Conda environment if you want
conda deactivate
```
---
### Setting up .env secrets:
```bash
# After coping add your API keys
cp .env.example .env
```
### Run the project:
```bash
npm run dev
```
## Running the project using Docker
First Install [**Docker Desktop**](https://www.docker.com/products/docker-desktop/)
**Pull the image**
```bash
docker pull surajkumar00/gurunimbus
```
**Run the Container**
```bash
docker run -it -p 3000:3000 surajkumar00/gurunimbus
```
On your browser check: [localhost:3000](localhost:3000)
## Welcome Contributros!
Want to contribute? Great!
[**Read the Contribution Guidlines**](https://github.com/Suraj-kumar00/GuruNimbus/blob/main/CONTRIBUTING.md)
## License
[Apache-2.0 license](https://github.com/Suraj-kumar00/GuruNimbus/blob/main/LICENSE)
## Support via giving a ⭐ star