Skip to content

QUICKSTART.md

Latest commit

 

History

History
95 lines (69 loc) · 2.36 KB

QUICKSTART.md

File metadata and controls

95 lines (69 loc) · 2.36 KB
Raw

Quick Start Guide

Installation and Setup

  1. Install Node.js (if not already installed)

    • Download from nodejs.org (v18 or higher)
    • Verify installation: node --version

  2. Install Dependencies

    cd frontend
npm install

  3. Configure Backend URL

    • Copy .env.example to .env.local
    • Update BACKEND_URL to match your backend service:
    BACKEND_URL=http://localhost:8000

  4. Start Development Server

    npm run dev

  5. Open Browser

Using the Application

Step 1: Input Transcript

Choose one of two methods:

Method A: Upload File

  • Click the upload area
  • Select a .txt file containing your transcript
  • Preview appears automatically

Method B: Paste Text

  • Click in the text area labeled "Paste Transcript"
  • Paste your transcript content (Ctrl+V / Cmd+V)

Step 2: Process

  • Click the "Process Transcript" button
  • Wait for processing to complete (spinner will appear)

Step 3: View Results

Navigate through the tabs to view different outputs:

Report Tab

  • Structured Markdown analysis
  • Formatted with headings, lists, and sections

JSON Output Tab

  • Full JSON response
  • Copy to clipboard with one click
  • Download as JSON file

Steps Tab

  • Accordion view of process steps
  • Click to expand/collapse individual steps
  • Use "Expand All" or "Collapse All" buttons

BPMN Viewer Tab

  • Visual process diagram
  • Use zoom controls to adjust view
  • Pan and explore the diagram

Example Files

Example transcript and response are included in the /examples folder:

  • example-transcript.txt - Sample bank account opening conversation
  • example-response.json - Expected backend response format

Troubleshooting

Problem: "Cannot connect to backend"

  • Solution: Verify backend is running and BACKEND_URL is correct

Problem: "Port 3000 already in use"

  • Solution: Use a different port: PORT=3001 npm run dev

Problem: Upload not working

  • Solution: Ensure file is .txt format

Next Steps

  • Review README.md for detailed documentation
  • Check TECHNICAL_DOCS.md for architecture details
  • Configure production deployment when ready

Need Help? Check the full README or technical documentation for more details.