Skip to content

SETUP.md

Latest commit

 

History

History
109 lines (81 loc) · 1.78 KB

SETUP.md

File metadata and controls

109 lines (81 loc) · 1.78 KB
Raw

BugSight Setup Guide

Prerequisites

Web App Setup

  1. Navigate to web directory:
cd web
  1. Install dependencies:
npm install
  1. Create .env.local file:
cp .env.local.example .env.local
  1. Add your Gemini API key to .env.local:
GEMINI_API_KEY=your_api_key_here
  1. Run development server:
npm run dev
  1. Open http://localhost:3000

VSCode Extension Setup

  1. Navigate to extension directory:
cd extension
  1. Install dependencies:
npm install
  1. Compile the extension:
npm run compile

  1. Open the extension folder in VSCode

  2. Press F5 to launch Extension Development Host

  3. In the new VSCode window, configure your Gemini API key:

    • Open Settings (Ctrl+,)
    • Search for "bugsight"
    • Add your API key

Building for Production

Web App

cd web
npm run build
npm start

VSCode Extension

cd extension
npm run package

This creates a .vsix file you can distribute.

Deployment

Web App

Deploy to Vercel:

cd web
vercel

Extension

Publish to VSCode Marketplace or distribute the .vsix file directly.

Features to Test

  1. Web App:

    • Paste an error and click "Analyze with AI"
    • Check Dashboard for error history
    • Toggle dark/light mode
    • Download extension from Extension Hub

  2. VSCode Extension:

    • Select error text and run "BugSight: Explain Error"
    • Check error history in sidebar
    • Terminal error auto-detection

Troubleshooting

  • If API calls fail, verify your Gemini API key
  • Clear browser localStorage to reset error history
  • For extension issues, check VSCode Developer Tools (Help > Toggle Developer Tools)