CipherPhantom commited on
Commit
b93eb1b
Β·
verified Β·
1 Parent(s): 9b9dce6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +99 -99
README.md CHANGED
@@ -1,99 +1,99 @@
1
- # RNGAI-WEB Chatbot
2
-
3
- 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.
4
-
5
- ## Features
6
-
7
- - πŸŽ“ Comprehensive information about RNGPIT
8
- - πŸ€– Powered by Groq AI (LLaMA models)
9
- - πŸ“š RAG-based knowledge retrieval
10
- - 🎨 Beautiful, modern UI with dark/light theme
11
- - πŸ“Š Admin dashboard with analytics
12
- - 🐳 Docker support for easy deployment
13
-
14
- ## Setup
15
-
16
- ### 1. Clone and Install
17
-
18
- ```bash
19
- cd RNGAI-WEB
20
- pip install -r requirements.txt
21
- ```
22
-
23
- ### 2. Configure Environment Variables
24
-
25
- Copy the example environment file:
26
-
27
- ```bash
28
- copy .env.example .env
29
- ```
30
-
31
- Then edit `.env` and add your credentials:
32
-
33
- ```env
34
- GROQ_API_KEY=your_groq_api_key_here
35
- SUPABASE_URL=your_supabase_url_here
36
- SUPABASE_KEY=your_supabase_key_here
37
- ```
38
-
39
- **Get your credentials:**
40
- - **Groq API**: https://console.groq.com
41
- - **Supabase**: https://supabase.com
42
-
43
- ### 3. Run the Application
44
-
45
- **Local Development:**
46
-
47
- ```bash
48
- python app.py
49
- ```
50
-
51
- **Using Docker:**
52
-
53
- ```bash
54
- docker-compose up -d
55
- ```
56
-
57
- The application will be available at: `http://localhost:5000`
58
-
59
- ## Project Structure
60
-
61
- ```
62
- RNGAI-WEB/
63
- β”œβ”€β”€ app.py # Main Flask application
64
- β”œβ”€β”€ requirements.txt # Python dependencies
65
- β”œβ”€β”€ .env # Environment variables (not in git)
66
- β”œβ”€β”€ .env.example # Environment template
67
- β”œβ”€β”€ Dockerfile # Docker configuration
68
- β”œβ”€β”€ docker-compose.yml # Docker Compose config
69
- β”œβ”€β”€ templates/
70
- β”‚ └── index.html # Main chat interface
71
- β”œβ”€β”€ static/
72
- β”‚ └── RNGPIT.png # College logo
73
- └── data/
74
- └── link17.txt # Knowledge base
75
- ```
76
-
77
- ## Environment Variables
78
-
79
- | Variable | Description | Required |
80
- |----------|-------------|----------|
81
- | `GROQ_API_KEY` | API key from Groq Console | Yes |
82
- | `SUPABASE_URL` | Your Supabase project URL | Yes |
83
- | `SUPABASE_KEY` | Your Supabase API key | Yes |
84
-
85
- ## Tech Stack
86
-
87
- - **Backend**: Flask, Python 3.11
88
- - **AI**: Groq (LLaMA 3.3), Sentence Transformers
89
- - **Vector DB**: ChromaDB
90
- - **Database**: Supabase
91
- - **Frontend**: HTML, CSS, JavaScript with Three.js
92
-
93
- ## Security
94
-
95
- ⚠️ **Important**: Never commit your `.env` file to version control. The `.env` file contains sensitive credentials and should be kept private.
96
-
97
- ## License
98
-
99
- Private project for RNG Patel Institute of Technology
 
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