Sambhaash_AI/instructions.txt at main · Rahul-8283/Sambhaash_AI · GitHub

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
100
101
102
103
104
======================================================================
SAMBHAASH AI - SYSTEM RUN & SETUP CHECKLIST (FRONTEND + BACKEND)
======================================================================

----------------------------------------------------------------------
1. PREREQUISITES & SERVICES
----------------------------------------------------------------------
Ensure you have the following installed on your host system:
- Node.js (v18 or higher)
- Python (v3.10 or higher)
- Docker Desktop (for starting Redis)
- Git (optional, for code sync)

----------------------------------------------------------------------
2. FRONTEND (FE) SETUP & RUNNING
----------------------------------------------------------------------
Navigate to the Frontend workspace:
$ cd Frontend

Step A: Install required node dependency packages
$ npm install

Step B: Create active local environment configurations
$ cp .env.example .env

Double-check the keys inside Frontend/.env:
VITE_API_BASE_URL_DEV=http://127.0.0.1:8000
VITE_API_BASE_URL_PRO=https://your-production-api-domain.com
MODE=development

Step C: Run the Vite live reloading development server
$ npm run dev

* Your Frontend web portal will launch at: http://localhost:5173

----------------------------------------------------------------------
3. BACKEND (BE) SETUP & RUNNING
----------------------------------------------------------------------
Navigate to the Backend workspace:
$ cd Backend

Step A: Create and activate a clean python virtual environment
$ python -m venv venv

- Activate on Windows (CMD/PowerShell):
$ venv\Scripts\activate

- Activate on Linux / macOS (Bash/Zsh):
$ source venv/bin/activate

Step B: Install all package requirements
$ pip install -r requirements.txt

Step C: Create active local environment configurations
$ cp .env.example .env

Ensure you populate Backend/.env with active keys:
- Supabase details (SUPABASE_URL, SUPABASE_SERVICE_ROLE_KEY, DATABASE_URL)
- LLM Provider API details (GROQ_API_KEY, SARVAM_API_KEY, HF_API_KEY)
- Telephony Credentials (TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN, TWILIO_PHONE_NUMBER)

Step D: Run a local Redis container instance (Required for task processing queues)
$ docker run -d --name sambhaash-redis -p 6379:6379 redis:alpine

Step E: Start the FastAPI API Web Application Server
$ python -m uvicorn main:app --reload

* The FastAPI server is active at: http://127.0.0.1:8000
* Swagger API Documentation is active at: http://127.0.0.1:8000/docs

Step F: Start the asynchronous background queue task worker
$ python run_worker.py

----------------------------------------------------------------------
4. TUNNELING WEBHOOKS FOR TELEPHONY & WHATSAPP
----------------------------------------------------------------------
If you want to receive active inbound Twilio calls or WhatsApp webhooks locally:
Step A: Spin up an ngrok http tunnel on port 8000
$ ngrok http 8000

Step B: Copy the resulting ngrok free URL (e.g. https://xxxx.ngrok-free.app)
Step C: Update your Twilio voice and messaging settings with this webhook destination.
Step D: Set TWILIO_WEBHOOK_BASE_URL inside your Backend/.env file to this URL.

----------------------------------------------------------------------
5. TWILIO FREE TRIAL ACCOUNT LIMITATION & PHONE VERIFICATION
----------------------------------------------------------------------
Note: If using Twilio Free Trial, calls and WhatsApp follow-up messages will
fail unless the testing phone number is verified inside your Twilio Console.

How to verify phone numbers:
1. Log in to your Twilio Account (https://www.twilio.com/console)
2. Go to Phone Numbers -> Verified Caller IDs
3. Click "Add a new Caller ID"
4. Enter your phone number (with country code, e.g., +91 for India)
5. Choose verification method:
   - SMS (you'll receive a code via text)
   - Voice call (automated call gives you the code)
6. Enter the verification code in the Twilio console
7. Done — your testing number is now verified and ready! ✅

======================================================================
Development setup is fully complete. Happy showcase!
======================================================================