Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,99 +1,99 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
-
|
| 11 |
-
|
| 12 |
-
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
##
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
```
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
**
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
#
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
##
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
##
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: RNGPIT AI Assistant
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: indigo
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 7860
|
| 8 |
+
app_file: app.py
|
| 9 |
+
pinned: false
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
# RNGAI-WEB Chatbot
|
| 13 |
+
|
| 14 |
+
This is an AI-powered chatbot for RNG Patel Institute of Technology (RNGPIT) that uses RAG (Retrieval Augmented Generation) to answer questions about courses, admissions, facilities, placements, and campus life.
|
| 15 |
+
|
| 16 |
+
## Features
|
| 17 |
+
|
| 18 |
+
- π Comprehensive information about RNGPIT
|
| 19 |
+
- π€ Powered by NVIDIA API (Llama 3.1 70B)
|
| 20 |
+
- π RAG-based knowledge retrieval
|
| 21 |
+
- π¨ Beautiful, modern UI with dark/light theme
|
| 22 |
+
- π Admin dashboard with analytics
|
| 23 |
+
- π³ Docker support for easy deployment
|
| 24 |
+
|
| 25 |
+
## Setup
|
| 26 |
+
|
| 27 |
+
### 1. Clone and Install
|
| 28 |
+
|
| 29 |
+
```bash
|
| 30 |
+
cd RNGAI-WEB
|
| 31 |
+
pip install -r requirements.txt
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
+
### 2. Configure Environment Variables
|
| 35 |
+
|
| 36 |
+
Copy the example environment file:
|
| 37 |
+
|
| 38 |
+
```bash
|
| 39 |
+
copy .env.example .env
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
Then edit `.env` and add your credentials:
|
| 43 |
+
|
| 44 |
+
```env
|
| 45 |
+
NVIDIA_API_KEY=your_nvidia_api_key_here
|
| 46 |
+
SUPABASE_URL=your_supabase_url_here
|
| 47 |
+
SUPABASE_KEY=your_supabase_key_here
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
**Get your credentials:**
|
| 51 |
+
- **NVIDIA API**: https://build.nvidia.com
|
| 52 |
+
- **Supabase**: https://supabase.com
|
| 53 |
+
|
| 54 |
+
### 3. Run the Application
|
| 55 |
+
|
| 56 |
+
**Local Development:**
|
| 57 |
+
|
| 58 |
+
```bash
|
| 59 |
+
python app.py
|
| 60 |
+
```
|
| 61 |
+
|
| 62 |
+
**Using Docker:**
|
| 63 |
+
|
| 64 |
+
```bash
|
| 65 |
+
docker-compose up -d
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
The application will be available at: `http://localhost:7860` (or the port specified in docker-compose)
|
| 69 |
+
|
| 70 |
+
## Project Structure
|
| 71 |
+
|
| 72 |
+
```
|
| 73 |
+
RNGAI-WEB/
|
| 74 |
+
βββ app.py # Main Flask application
|
| 75 |
+
βββ requirements.txt # Python dependencies
|
| 76 |
+
βββ .env # Environment variables (not in git)
|
| 77 |
+
βββ .env.example # Environment template
|
| 78 |
+
βββ Dockerfile # Docker configuration
|
| 79 |
+
βββ docker-compose.yml # Docker Compose config
|
| 80 |
+
βββ templates/
|
| 81 |
+
βββ static/
|
| 82 |
+
βββ data/
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
## Environment Variables
|
| 86 |
+
|
| 87 |
+
| Variable | Description | Required |
|
| 88 |
+
|----------|-------------|----------|
|
| 89 |
+
| `NVIDIA_API_KEY` | API key from NVIDIA | Yes |
|
| 90 |
+
| `SUPABASE_URL` | Your Supabase project URL | Yes |
|
| 91 |
+
| `SUPABASE_KEY` | Your Supabase API key | Yes |
|
| 92 |
+
|
| 93 |
+
## Tech Stack
|
| 94 |
+
|
| 95 |
+
- **Backend**: Flask, Python 3.11
|
| 96 |
+
- **AI**: NVIDIA API (Llama 3.1), Sentence Transformers
|
| 97 |
+
- **Vector DB**: ChromaDB
|
| 98 |
+
- **Database**: Supabase
|
| 99 |
+
- **Frontend**: HTML, CSS, JavaScript
|