Skip to content

QUICK_START.md

Latest commit

 

History

History
132 lines (94 loc) · 2.55 KB

QUICK_START.md

File metadata and controls

132 lines (94 loc) · 2.55 KB

Quick Start Guide

Prerequisites

  • Python 3.9+
  • Node.js 16+
  • MongoDB (running on localhost:27017)

Option 1: Automated Start (Recommended)

./start-dev.sh

This script will:

Option 2: Manual Start

1. Start MongoDB

# Using Homebrew
brew services start mongodb-community

# OR using Docker
docker run -d -p 27017:27017 mongo:latest

2. Start Backend

cd backend
python3 -m app.main

Backend will start on http://localhost:8000

3. Start Frontend

cd src/frontend
npm install  # First time only
npm start

Frontend will start on http://localhost:3000

Verify Installation

Backend Health Check

curl http://localhost:8000/health
# Should return: {"status": "healthy"}

Run Backend Tests

cd backend
python3 test_e2e.py
# All tests should pass

Using the Application

  1. Open browser to http://localhost:3000
  2. Enter a task description:
    • "Check invoice payment status"
    • "Perform closing reconciliation"
    • "Review audit evidence"
  3. Click Submit
  4. Watch agents analyze and process the task
  5. Approve the plan when prompted
  6. See the specialized agent complete the task

Configuration

Frontend configuration is in:

  • src/frontend/public/config.json - Runtime config
  • src/frontend/.env - Environment variables

Backend configuration is in:

  • backend/.env - Environment variables

Troubleshooting

Backend won't start

# Check if port 8000 is in use
lsof -i :8000

# Check MongoDB is running
mongosh --eval "db.version()"

Frontend won't start

# Check if port 3000 is in use
lsof -i :3000

# Clear node_modules and reinstall
cd src/frontend
rm -rf node_modules package-lock.json
npm install

WebSocket connection fails

  1. Verify backend is running: curl http://localhost:8000/health
  2. Check browser console for errors
  3. Verify config.json has correct API_URL

Next Steps

Support

If you encounter issues:

  1. Check logs: backend.log and frontend.log
  2. Run tests: cd backend && python test_e2e.py
  3. Review troubleshooting section above
  4. Check FRONTEND_INTEGRATION_GUIDE.md