evaldoc 1.0.0

package/docs/QUICKSTART.md

@@ -0,0 +1,252 @@
+# Quick Start - Deploy EvalDoc to Firebase Online
+
+This guide will get your EvalDoc application live in under 10 minutes (assuming Firebase CLI works).
+
+## Current Situation
+
+✅ **Code is ready** - All files configured for Firebase project `evaldocplatform`
+❌ **Not deployed yet** - Needs to be deployed to Firebase online services
+⚠️ **LLM is stubbed** - Works but gives fake responses (fix after deployment)
+
+---
+
+## Deploy Now (3 Steps)
+
+### Step 1: Login to Firebase
+
+```bash
+npx firebase-tools@latest login
+```
+
+This will open a browser for Google authentication. Login with the Google account that has access to the `evaldocplatform` project.
+
+### Step 2: Deploy Everything
+
+```bash
+cd /Users/ridelink/Documents/GitHub/EvalDoc
+npx firebase-tools@latest deploy
+```
+
+This deploys:
+- ✅ Firestore security rules
+- ✅ Firestore indexes
+- ✅ Cloud Functions (API backend)
+- ✅ Hosting (frontend)
+
+Wait 2-5 minutes for deployment to complete.
+
+### Step 3: Enable Firebase Authentication
+
+1. Go to [Firebase Console](https://console.firebase.google.com/)
+2. Select project: **evaldocplatform**
+3. Click **Authentication** in left menu
+4. Click **Get Started**
+5. Click **Email/Password** → **Enable** → **Save**
+
+---
+
+## Your App is Live! 🎉
+
+**Provider Console:** https://evaldocplatform.web.app/app
+
+### Test It
+
+1. **Create Provider Account**
+   - Visit: https://evaldocplatform.web.app/app
+   - Click "Create account"
+   - Enter email/password
+   - Fill in provider details
+   - Choose handle (e.g., "dr-smith")
+   - Select topics
+   - Change status to "Published"
+   - Click "Save settings"
+
+2. **Test Patient Chat**
+   - Visit: https://evaldocplatform.web.app/dr-smith (your handle)
+   - Select a topic
+   - Send a test message
+   - You'll get a response (stubbed for now)
+
+3. **Check Analytics**
+   - Go back to: https://evaldocplatform.web.app/app
+   - View your conversation stats
+
+---
+
+## What Works Now
+
+✅ Provider signup and authentication
+✅ Provider profile customization
+✅ Handle-based public links
+✅ Patient chat interface
+✅ Safety checks (blocks diagnosis/dosing)
+✅ PII redaction (SSN, email, phone)
+✅ Red flag escalation
+✅ Topic selection
+✅ Analytics tracking
+✅ Rate limiting (50 chats/month)
+
+## What's Stubbed
+
+🟡 **LLM Responses** - Currently just echoes with generic text
+🟡 **QR Code Generation** - Canvas exists but not implemented
+
+---
+
+## Next Step: Add Real AI Responses
+
+The app works but gives fake responses. To fix:
+
+### Option A: OpenAI Integration (Easiest)
+
+```bash
+cd functions
+npm install openai
+```
+
+Edit `functions/src/llm.js`:
+
+```javascript
+const OpenAI = require('openai');
+
+const openai = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY // Set via Firebase config
+});
+
+async function generateResponse({ topicConfig, message, provider }) {
+  try {
+    const completion = await openai.chat.completions.create({
+      model: "gpt-4o-mini", // Cheaper, faster
+      messages: [
+        {
+          role: "system",
+          content: `${topicConfig.prompt}
+Provider: ${provider.displayName} (${provider.specialty})
+CRITICAL: Never diagnose, prescribe, or give dosing instructions.
+${topicConfig.disclaimer}`
+        },
+        { role: "user", content: message }
+      ],
+      max_tokens: 150,
+      temperature: 0.3
+    });
+
+    return completion.choices[0].message.content;
+  } catch (error) {
+    console.error('OpenAI error:', error);
+    return "I'm having trouble responding right now. Please try again.";
+  }
+}
+
+module.exports = { generateResponse };
+```
+
+Set your API key:
+```bash
+npx firebase-tools@latest functions:config:set openai.key="sk-your-key-here"
+```
+
+Redeploy:
+```bash
+npx firebase-tools@latest deploy --only functions
+```
+
+### Option B: Anthropic Claude
+
+```bash
+cd functions
+npm install @anthropic-ai/sdk
+```
+
+Similar integration pattern.
+
+### Option C: Google Vertex AI (Best for Firebase)
+
+Already has Google Cloud credentials, no extra API keys needed!
+
+---
+
+## Troubleshooting
+
+### Firebase CLI not working?
+
+If you get errors with `npx firebase-tools`, try:
+
+1. **Clean npm cache:**
+   ```bash
+   npm cache clean --force
+   ```
+
+2. **Install globally:**
+   ```bash
+   npm install -g firebase-tools@latest
+   firebase login
+   firebase deploy
+   ```
+
+3. **Use Firebase Console (Manual):**
+   - Go to https://console.firebase.google.com/
+   - Deploy functions, rules, and hosting manually
+
+### "Provider not found" error?
+
+- Make sure you set status to "Published" (not "Draft")
+- Check the handle is correct in the URL
+- Wait 30 seconds after saving settings
+
+### Authentication not working?
+
+- Verify Email/Password is enabled in Firebase Console
+- Check browser console for errors
+- Try incognito mode
+
+### Functions not deployed?
+
+Check logs:
+```bash
+npx firebase-tools@latest functions:log
+```
+
+Or in Firebase Console → Functions → Logs
+
+---
+
+## Monitoring
+
+After deployment:
+
+- **Functions Dashboard:** https://console.firebase.google.com/project/evaldocplatform/functions
+- **Firestore Data:** https://console.firebase.google.com/project/evaldocplatform/firestore
+- **Authentication:** https://console.firebase.google.com/project/evaldocplatform/authentication
+- **Hosting:** https://console.firebase.google.com/project/evaldocplatform/hosting
+
+---
+
+## Cost Estimate
+
+With Firebase free tier:
+- **50 providers × 50 chats/month = 2,500 chats/month**
+- **Firestore:** ~7,500 reads, ~5,000 writes (within free tier)
+- **Functions:** ~2,500 invocations (within free tier)
+- **Hosting:** Minimal bandwidth (within free tier)
+
+**Total cost: $0/month** (assuming you stay within free tier)
+
+LLM costs (OpenAI GPT-4o-mini):
+- ~$0.15 per 1M input tokens
+- ~$0.60 per 1M output tokens
+- **Estimated:** ~$0.50/month for 2,500 chats
+
+---
+
+## Support
+
+Need help?
+1. Check [DEPLOYMENT.md](DEPLOYMENT.md) for detailed instructions
+2. Review [SRS.md](SRS.md) for requirements
+3. Check Firebase logs for errors
+4. Open GitHub issue (if repo set up)
+
+---
+
+**You're ready to deploy! Run the 3 steps above to get live in 10 minutes.**

package/docs/QUICK_REFERENCE.md

@@ -0,0 +1,222 @@
+# EvalDoc Thread System - Quick Reference
+
+## 🚀 Deploy in 3 Steps
+
+```bash
+# 1. Enable Google Sign-In in Firebase Console
+#    → Authentication → Sign-in method → Enable Google
+
+# 2. Deploy everything
+firebase deploy --only firestore:rules,functions,hosting
+
+# 3. Test
+#    Visit: your-domain.com/dr-handle
+#    Sign in with Google → Send message → Works!
+```
+
+---
+
+## 📁 Key Files
+
+### Frontend
+- `public/chat.html` - Patient chat UI (with Google auth modal)
+- `public/js/chat-threads.js` - Thread-based chat logic
+- `public/app/inbox.html` - Doctor inbox UI
+- `public/app/inbox-threads.js` - Thread inbox logic
+
+### Backend
+- `functions/src/patient-api.js` - Patient API endpoints
+- `functions/src/index.js` - Doctor API endpoints + routing
+- `firestore.rules` - Security rules
+
+### Docs
+- `DEPLOYMENT_STEPS.md` - Full deployment guide
+- `THREAD_IMPLEMENTATION_GUIDE.md` - Technical details
+- `ARCHITECTURE_SUMMARY.md` - Visual diagrams
+- `THREADS_IMPLEMENTATION_COMPLETE.md` - Summary
+
+---
+
+## 🗂 Data Structure
+
+```
+patients/{patientId}
+  email, displayName, photoURL, doctorIds[]
+
+threads/{thread_patientId_doctorId}
+  patientId, doctorId, lastMessageAt, unreadCounts, status
+  → messages/{messageId}
+      role, message, createdAt, readStatus
+```
+
+---
+
+## 🔌 API Endpoints
+
+### Patient
+```
+POST /api/patient/create              Create profile
+POST /api/patient/thread              Get/create thread
+POST /api/patient/message             Send message
+GET  /api/patient/thread/:id/messages Load history
+```
+
+### Doctor
+```
+GET   /api/doctor/threads             Get inbox
+GET   /api/doctor/thread/:id          Get thread
+POST  /api/doctor/message             Send reply
+PATCH /api/doctor/thread/:id          Update status
+```
+
+---
+
+## 🎯 Features
+
+### Patient
+- Google Sign-In (one time)
+- Persistent threads (never lost)
+- Multiple doctors (separate threads)
+- Works everywhere (cross-device)
+
+### Doctor
+- See patient names (not IDs)
+- Manual reply (text box)
+- Override AI (toggle button)
+- Unread indicators
+- Archive/escalate threads
+
+---
+
+## 🧪 Test Scenarios
+
+### New Patient
+```
+1. Visit doctor link
+2. Try to send message
+3. Sign in with Google
+4. Message sends → AI responds
+5. Refresh → History persists ✅
+```
+
+### Doctor Reply
+```
+1. Login to /app/inbox
+2. See patient thread (green dot if unread)
+3. Click thread
+4. Type reply → Send
+5. Patient receives message ✅
+```
+
+### Manual Mode
+```
+1. Doctor clicks "Take Over"
+2. AI stops responding
+3. All messages are manual
+4. Toggle back to enable AI ✅
+```
+
+---
+
+## 🔐 Security
+
+- Patients: Only access own threads
+- Doctors: Only access own threads
+- All writes: Backend API only
+- Google tokens: Verified server-side
+
+---
+
+## 🐛 Troubleshooting
+
+### "Unauthorized" error
+- Check Google Sign-In is enabled
+- Verify token in request headers
+- Re-deploy Firestore rules
+
+### Messages not persisting
+- Check Firestore console for `threads` collection
+- Verify API endpoints are deployed
+- Check browser console for errors
+
+### Google Sign-In fails
+- Add domain to authorized domains
+- Check Firebase config in `/app/config.js`
+- Clear browser cache
+
+---
+
+## 💡 Quick Tips
+
+1. **Thread ID format:** `thread_{patientId}_{doctorId}`
+2. **Message roles:** `patient`, `doctor`, `ai`
+3. **Status values:** `active`, `archived`, `escalated`
+4. **Override mode:** Disables AI, forces manual replies
+5. **Unread counts:** `unreadByPatient`, `unreadByDoctor`
+
+---
+
+## 📊 Monitoring
+
+### Firebase Console
+- **Authentication** → See new Google users
+- **Firestore** → Check `threads` collection
+- **Functions** → View API logs
+
+### Key Metrics
+- New patient signups (Authentication)
+- Thread creation rate (Firestore)
+- Messages per thread (avg)
+- Doctor response time (manual replies)
+
+---
+
+## 🎨 Customization
+
+### Change Google button color
+Edit `public/chat.html` → `#googleSignInBtn` style
+
+### Change thread status options
+Edit `functions/src/patient-api.js` → `status` field
+
+### Add new message types
+Add to `functions/src/patient-api.js` → `role` enum
+
+---
+
+## 📞 Next Steps
+
+### Phase 3 (Optional)
+- [ ] Push notifications
+- [ ] Real-time updates (WebSockets)
+- [ ] File sharing in threads
+- [ ] Video consultations
+- [ ] Export chat history
+
+---
+
+## ✅ Production Checklist
+
+- [ ] Google Sign-In enabled
+- [ ] Firestore rules deployed
+- [ ] Functions deployed
+- [ ] Hosting deployed
+- [ ] Test patient flow
+- [ ] Test doctor reply
+- [ ] Monitor Firebase logs
+- [ ] Check no console errors
+
+---
+
+## 🆘 Need Help?
+
+1. Read `DEPLOYMENT_STEPS.md`
+2. Check Firebase Console logs
+3. Look at browser DevTools console
+4. Review Firestore security rules
+
+---
+
+**Status:** ✅ Ready to Deploy
+**Time to Deploy:** ~15 minutes
+**Architecture:** Thread-based with Google Auth