5050## 🔗 Links
5151
5252- 🌍 ** Landing Website** : [ qbiv.netlify.app] ( https://qbiv.netlify.app )
53- - 📥 ** Download QBIV (v1.0.0 Alpha)** :
54- - [ ⬇️ Windows (.exe)] ( https://example.com/qbiv-win.exe )
55- - [ ⬇️ macOS (.dmg)] ( https://example.com/qbiv-mac.dmg )
56- - [ ⬇️ Linux (.AppImage)] ( https://example.com/qbiv-linux.AppImage )
5753
5854---
5955
7167
7268---
7369
74- ## 📦 Installation (Development Mode)
70+ ## ✅ Full Setup Guide for QBIV (Main App + AI Proxy)
71+
72+ ### 1. ** Clone and Set Up the AI Proxy First**
73+
74+ The AI proxy acts as a local server that converts natural language prompts to SQL via Groq API.
75+
76+ ``` bash
77+ # Clone the AI proxy repo
78+ git clone https://github.com/sai-zack-dev/qbiv-ai-proxy.git
79+
80+ cd qbiv-ai-proxy
81+
82+ # Install dependencies
83+ npm install
84+
85+ # Create .env file
86+ cp .env.example .env
87+ ```
88+
89+ Then open ` .env ` and fill in:
90+
91+ ``` env
92+ GROQ_API_KEY=your-real-api-key-here
93+ ```
94+
95+ > 🔑 ** How to get a Groq API Key:**
96+ >
97+ > 1 . Go to [ https://console.groq.com/keys ] ( https://console.groq.com/keys ) (you need to sign in).
98+ > 2 . Click ** “Create Key”** .
99+ > 3 . Copy the key and paste it into the ` .env ` file under ` GROQ_API_KEY ` .
100+
101+ ### 2. ** Run the AI Proxy Server**
102+
103+ After setting the key:
75104
76105``` bash
77- # Clone the repo
106+ node index.js
107+ ```
108+
109+ This will start the proxy on ** ` http://localhost:3000 ` ** .
110+
111+ ### 3. ** Clone and Set Up the Main QBIV App**
112+
113+ ``` bash
114+ # In another terminal tab or window
78115git clone https://github.com/sai-zack-dev/query-based-intelligence-visualization.git
79116
80117cd query-based-intelligence-visualization
81118
82119# Install dependencies
83120npm install
84121
85- # Start the Electron app
122+ # Create a .env file
123+ cp .env.example .env
124+ ```
125+
126+ Update ` .env ` in the ** main app** :
127+
128+ ``` env
129+ AI_API_BASE=http://localhost:3000
130+ ```
131+
132+ ### 4. ** Start the Main Electron App**
133+
134+ ``` bash
86135npm run dev
87- ````
136+ ```
137+
138+
139+ ## 🧠 Notes
140+
141+ * Your Electron app will use ` process.env.AI_API_BASE ` to send prompts to the AI proxy.
142+ * The proxy securely calls Groq API with your ` GROQ_API_KEY ` .
88143
89144Make sure you have:
90145
@@ -104,7 +159,7 @@ Make sure you have:
104159
105160---
106161## 📋 Poster and Slides
107- ! [Wireframe Version 2](./public/readme/poster .png)
162+ ![ Poster 2] ( ./public/readme/Poster .png )
108163
109164** Presentation Slides** : [ canva.qbiv] ( https://www.canva.com/design/DAGuhi0refg/RlUnOanhwOrlcLiARaEslw/view?utm_content=DAGuhi0refg&utm_campaign=designshare&utm_medium=link2&utm_source=uniquelinks&utlId=h031efc99a6%27#1 )
110165
0 commit comments