Skip to content

Commit aeb92c0

Browse files
committed
updated setup instructions in Readme
1 parent ab32dda commit aeb92c0

1 file changed

Lines changed: 31 additions & 11 deletions

File tree

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,32 @@
22
![Perspective banner](frontend/public/perspective_banner.jpg)
33

44
### Table of Contents
5-
- [System Overview](#system-overview)
6-
- [Architecture Components](#architecture-components)
7-
- [Technical Stack](#technical-stack)
8-
- [Core Features](#core-features)
9-
- [Data Flow & Security](#data-flow--security)
10-
- [Setup & Deployment](#setup--deployment)
11-
- [Detailed Architecture Diagram](#detailed-architecture-diagram)
12-
- [Expected Outcomes](#expected-outcomes)
13-
- [Required Skills](#required-skills)
5+
- [Perspective-AI](#perspective-ai)
6+
- [Table of Contents](#table-of-contents)
7+
- [System Overview](#system-overview)
8+
- [High-Level Concept](#high-level-concept)
9+
- [Architecture Components](#architecture-components)
10+
- [1. Frontend Layer](#1-frontend-layer)
11+
- [3. Core Backend](#3-core-backend)
12+
- [4. AI \& NLP Integration](#4-ai--nlp-integration)
13+
- [5. Data Storage](#5-data-storage)
14+
- [Technical Stack](#technical-stack)
15+
- [Frontend Technologies](#frontend-technologies)
16+
- [Backend Technologies](#backend-technologies)
17+
- [I Integration](#i-integration)
18+
- [Core Features](#core-features)
19+
- [1. Counter-Perspective Generation](#1-counter-perspective-generation)
20+
- [2. Reasoned Thinking](#2-reasoned-thinking)
21+
- [3. Updated Facts](#3-updated-facts)
22+
- [4. Seamless Integration](#4-seamless-integration)
23+
- [5. Real-Time Analysis](#5-real-time-analysis)
24+
- [Data Flow \& Security](#data-flow--security)
25+
- [Setup \& Deployment](#setup--deployment)
26+
- [Frontend Setup](#frontend-setup)
27+
- [Backend Setup](#backend-setup)
28+
- [Architecture Diagram](#architecture-diagram)
29+
- [Expected Outcomes](#expected-outcomes)
30+
- [Required Skills](#required-skills)
1431

1532
---
1633

@@ -137,12 +154,15 @@ npm run dev
137154
- add .env file in `/new-backend`directory.
138155
- add following environment variable in your .env file.
139156
```
140-
HF_TOKEN = <Your_hugging_face_access_token>
157+
GROQ_API_KEY= <groq_api_key>
158+
PINECONE_API_KEY = <your_pinecone_API_KEY>
159+
PORT = 8000
160+
SEARCH_KEY = <your_Google_custom_search_engine_API_key>
141161
```
142162

143163
*Run backend:*
144164
```bash
145-
cd new-backend
165+
cd backend
146166
uv sync # Creating virtual environment at: .venv
147167
uv run main.py #Runs the backend server
148168
```

0 commit comments

Comments
 (0)