Skip to content

QUICKSTART.md

Latest commit

 

History

History
107 lines (75 loc) · 1.99 KB

QUICKSTART.md

File metadata and controls

107 lines (75 loc) · 1.99 KB
Raw

Quick Start Guide

Prerequisites

  1. Ollama installed and running

  2. Docker installed and running

  3. Python 3.10+ and Node.js 18+

Setup Steps

1. Install Ollama Models

ollama pull qwen2.5:7b-instruct
ollama pull qwen3-embedding:4b

2. Start Neo4j

docker-compose up -d

Wait ~10 seconds for Neo4j to initialize.

3. Install Backend Dependencies

cd backend
pip install -r requirements.txt
cd ..

4. Install Frontend Dependencies

cd frontend
npm install
cd ..

Running the Application

Terminal 1: Backend

cd backend
uvicorn main:app --reload

Backend will run on http://localhost:8000

Terminal 2: Frontend

cd frontend
npm start

Frontend will run on http://localhost:3000

Using the Application

  1. Create a Project: Click "New Project" on the dashboard
  2. Import Documents:
    • Open your project
    • Click "Import Document"
    • Select file and domain
    • Wait for processing
  3. View Graph: The graph will appear automatically after import
  4. View Evidence: Click on nodes or edges to see source evidence
  5. Edit Graph: Use the edit API endpoints (or add UI controls)

Troubleshooting

Neo4j Connection Issues

  • Ensure Docker is running: docker ps
  • Check Neo4j logs: docker logs ideagraph-neo4j
  • Verify connection: docker exec -it ideagraph-neo4j cypher-shell -u neo4j -p ideagraph

Ollama Issues

  • Verify Ollama is running: ollama list
  • Test model: ollama run qwen2.5:7b-instruct "Hello"

Import Fails

  • Check file format is supported (PDF, DOCX, MD, TXT, TEX, JSON)
  • Ensure document has digital text (no scanned PDFs)
  • Check backend logs for detailed error messages

API Documentation

Once the backend is running, visit:

Testing

Run backend tests:

cd backend
pytest