Skip to content

Commit

Permalink
feat: The README file is well structured.
Browse files Browse the repository at this point in the history
  • Loading branch information
Suraj-kumar00 committed Aug 27, 2024
1 parent b2b7349 commit f4c2c3c
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 10 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
![GuruNimbus Banner]()
![GuruNimbus Banner](./public/GuruNimbus-README-banner.png)

**"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
Expand All @@ -15,15 +20,15 @@
- OpenAI

## For APIs
- Openrouter
- Gemini API
- Openrouter API Key
- Gemini API Key

## DevOps Practices
- CI/CD with GitHub Actions
- Dockerization

## Project Workflow
![GuruNimbus Project Workflow]()
![GuruNimbus Project Workflow](./public/GuruNimbus-Project-Workflow.png)


### Installation for local development:
Expand Down Expand Up @@ -64,6 +69,11 @@ conda deactivate
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/)

Expand All @@ -75,10 +85,8 @@ docker pull surajkumar00/gurunimbus
```bash
docker run -it -p 3000:3000 surajkumar00/gurunimbus
```
On your browser check:
```sh
localhost:3000
```
On your browser check: [localhost:3000](localhost:3000)


## Welcome Contributros!
Want to contribute? Great!
Expand Down
Binary file added public/GuruNimbus-Project-Workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/GuruNimbus-README-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion public/next.svg

This file was deleted.

1 change: 0 additions & 1 deletion public/vercel.svg

This file was deleted.

0 comments on commit f4c2c3c

Please sign in to comment.