StudyAssistant/QUICK_START.txt at main · hrideymarwah15/StudyAssistant · 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

╔════════════════════════════════════════════════════════════════╗
║                   STUDYPAL LOCAL HOSTING                       ║
║                      QUICK START GUIDE                         ║
╚════════════════════════════════════════════════════════════════╝


┌─────────────────────────────────────────────────────────────────┐
│  STEP 1: ONE-COMMAND SETUP                                      │
└─────────────────────────────────────────────────────────────────┘

Run this command to start everything:

    ./scripts/start_everything.sh

This will:
  ✓ Check/start Qdrant (Docker)
  ✓ Check Ollama + AI models
  ✓ Start FastAPI backend
  ✓ Create public HTTPS tunnel
  ✓ Show your public URL


┌─────────────────────────────────────────────────────────────────┐
│  STEP 2: COPY YOUR TUNNEL URL                                   │
└─────────────────────────────────────────────────────────────────┘

From the script output, copy the HTTPS URL:

    https://abc123.ngrok-free.app
    OR
    https://xyz.trycloudflare.com


┌─────────────────────────────────────────────────────────────────┐
│  STEP 3: SET IN NETLIFY                                         │
└─────────────────────────────────────────────────────────────────┘

  1. Go to: https://app.netlify.com/sites/assistantstudy
  2. Site settings → Environment variables
  3. Add/Update:
     • Key: NEXT_PUBLIC_API_URL
     • Value: <your-tunnel-url>
  4. Trigger deploy


┌─────────────────────────────────────────────────────────────────┐
│  STEP 4: TEST                                                    │
└─────────────────────────────────────────────────────────────────┘

  1. Open: https://assistantstudy.netlify.app
  2. Check JARVIS status: Should show "AI ONLINE" 🟢
  3. Try asking a question
  4. Upload study materials
  5. Generate flashcards


═══════════════════════════════════════════════════════════════════


🔧 MANUAL SETUP (if preferred)
═══════════════════════════════════════════════════════════════════

Terminal 1 - Qdrant:
    docker start qdrant

Terminal 2 - Ollama:
    ollama serve

Terminal 3 - Backend:
    ./scripts/run_local_backend.sh

Terminal 4 - Tunnel:
    ./scripts/setup_tunnel.sh


═══════════════════════════════════════════════════════════════════


🧪 VERIFY SERVICES
═══════════════════════════════════════════════════════════════════

Run this to check all services:

    ./scripts/test_services.sh


Expected output:
    ✅ Qdrant running
    ✅ Ollama running
    ✅ mixtral model found
    ✅ qwen model found
    ✅ Backend healthy


═══════════════════════════════════════════════════════════════════


📚 DOCUMENTATION
═══════════════════════════════════════════════════════════════════

Complete Guide:
    docs/local_hosting.md

Quick Reference:
    docs/QUICKSTART.md

Summary:
    LOCAL_HOSTING_COMPLETE.md


═══════════════════════════════════════════════════════════════════


🆘 TROUBLESHOOTING
═══════════════════════════════════════════════════════════════════

Port already in use:
    lsof -ti:8000 | xargs kill -9

Qdrant not running:
    docker start qdrant

Ollama not responding:
    # Kill existing and restart
    killall ollama
    ollama serve

Missing models:
    ollama pull mixtral
    ollama pull qwen2.5:14b


═══════════════════════════════════════════════════════════════════


🎯 RESULT
═══════════════════════════════════════════════════════════════════

When everything is working:

  Local Services:
    • Backend:  http://localhost:8000
    • Qdrant:   http://localhost:6333
    • Ollama:   http://localhost:11434

  Public:
    • Tunnel:   https://your-tunnel-url
    • Frontend: https://assistantstudy.netlify.app

  Status:
    • JARVIS: "AI ONLINE" 🟢
    • All AI features working
    • Materials stored locally
    • Secure HTTPS connection


═══════════════════════════════════════════════════════════════════


Ready to start?

    ./scripts/start_everything.sh