Skip to main content

🚀 1-2-3 Quick Start: Knowledge Base Guide

Get the Coditect Knowledge Base up and running in 3 simple steps!

Prerequisites (One-Time Setup)​

# Check you have these installed:
node --version  # Need v18+
python3 --version  # Need Python 3.8+

🎯 Step 1: Install & Build Knowledge Base (2 minutes)​

# Navigate to knowledge base directory
cd knowledge-base

# Install Python dependencies
pip3 install -r requirements.txt

# Build the knowledge base (if not already built)
python3 setup_chromadb.py

# You should see:
# ✓ Loaded 127 files
# ✓ Created 1000+ chunks
# ✓ Knowledge base ready!

🌐 Step 2: Start the Web Interface (1 minute)​

# Navigate to UI directory
cd ../knowledge-base-ui

# Install dependencies (first time only)
npm install

# Start BOTH servers with one command:
npm run server & npm run dev

# Or use two terminals:
# terminal 1: npm run server  (API on port 5175)
# terminal 2: npm run dev     (UI on port 5174)

🎉 Open http://localhost:5174 in your browser!

🔍 Step 3: Start Searching! (Instant)​

Try These Example Searches:​

  1. Find a Recent Error Solution:

    Search: "InversifyJS ambiguous match error"
    ✓ Solutions only filter

  2. Browse by Category:

    • Click "Browse" in nav
    • Select category badges
    • View recent solutions & blockers

  3. Check Analytics:

    • Click "Analytics" in nav
    • See real-time metrics
    • Explore query patterns

🎮 Power User Features​

Advanced Search Filters​

Click "Advanced Filters" to:

  • Filter by categories (debugging, frontend, etc.)
  • Set time windows (last 7 days, 30 days)
  • Adjust relevance threshold
  • Show only completed solutions

Quick Searches from Browse Page​

  • Click any category to instant-search
  • View solution counts per category
  • Check active blockers

Analytics Dashboard​

  • Real-time performance metrics
  • Top search queries
  • Common query sequences
  • Success rate tracking

🛠️ Troubleshooting​

"Connection Failed" Error​

# Make sure API server is running:
ps aux | grep "node server.js"
# If not, restart: npm run server

"No Results Found"​

  • Knowledge base might be empty
  • Run: cd ../knowledge-base && python3 setup_chromadb.py

Port Already in Use​

# Kill existing processes:
lsof -ti:5174 | xargs kill -9
lsof -ti:5175 | xargs kill -9

🎯 IDE Integration (Optional)​

For theia Users:​

cd ../theia-kb-extension
npm install
npm run build

# Add to your theia app and rebuild
# Access via View → Knowledge Base

Quick IDE Features:​

  • Select code → Search in KB
  • Apply solutions directly to editor
  • Side panel with categories

📝 Cheat Sheet​

Essential Commands​

# Start everything
cd knowledge-base-ui && npm run server & npm run dev

# Stop everything  
Ctrl+C (twice)

# Rebuild KB
cd ../knowledge-base && python3 setup_chromadb.py

# Check KB stats
python3 query_kb.py -i
> stats

Search Tips​

  • Exact errors: Copy/paste error messages
  • Concepts: "React hooks useState"
  • Problems: "deployment failed GCP"
  • Patterns: "debugging TypeScript"

Keyboard Shortcuts (Web UI)​

  • / - Focus search box
  • Enter - Execute search
  • Tab - Navigate results

🎉 That's It!​

You now have access to:

  • 115,000+ lines of searchable development history
  • Semantic search that understands context
  • Real-time analytics on knowledge usage
  • Solution patterns from past experiences

Happy Searching! 🔍

🔗 Quick Links​

Last Updated: 2025-10-09