Welcome to OpenWebAnswer documentation! This directory contains comprehensive guides for setting up, using, and developing the system.
- Quick Start - 5-minute quick start in root README
- Setup Instructions - Installation for Windows, Linux, macOS
| Document | Purpose | Best For |
|---|---|---|
| ARCHITECTURE.md | System design, components, data flow | Understanding how the system works |
| API.md | REST API endpoints, request/response formats | Building integrations |
| DATABASE.md | SQLite schema, tables, relationships | Database administration |
| DEVELOPMENT.md | Contributing guidelines, development setup | Contributing to the project |
| TROUBLESHOOTING.md | Common issues and solutions | Debugging problems |
Choose your platform:
- SETUP_WINDOWS.md - Windows (PowerShell) setup
- SETUP_LINUX.md - Linux/Ubuntu (bash) setup
- SETUP_MACOS.md - macOS (zsh/bash) setup
✅ Multi-engine web search
✅ Vector embeddings (FAISS)
✅ LLM integration (OpenAI, Anthropic, Ollama, HuggingFace)
✅ Intelligent caching (SQLite)
✅ Source quality scoring
✅ Follow-up question generation
✅ Comprehensive analytics & tracking
See ARCHITECTURE.md for full technical details.
- 📖 Getting Started: See setup guide for your platform above
- 🔧 Configuration: Copy
.env.example→.envand add your API keys - 🚀 API Documentation: Visit
http://localhost:8000/docsafter starting - 🐛 Having Issues?: See TROUBLESHOOTING.md
- 📊 Performance Data: Query
/api/analytics/*endpoints
| Metric | Target |
|---|---|
| Response time (cache hit) | < 0.5s |
| Response time (first query) | < 20s |
| Vector search | < 100ms |
| Cache hit rate | > 60% |
- Backend: FastAPI, Python 3.9+
- Frontend: React, Vite
- Database: SQLite
- Vector DB: FAISS
- Embeddings: Sentence Transformers (all-MiniLM-L6-v2)
- LLM: OpenAI, Anthropic, Ollama, HuggingFace
Last Updated: December 13, 2025 (Phase 7: Documentation Finalization)
Version: 1.0
Status: Production-Ready ✅