Web UI
📝 Prerequisites
Section titled “📝 Prerequisites”Before starting the web interface:
- Complete Setup: Follow the Quick Start Guide for initial setup
- API Server Running: The web interface requires the API server
- Environment Configured: Ensure
.env
file is properly set up
🌐 Starting the Web Interface
Section titled “🌐 Starting the Web Interface”From Root (Recommended)
Section titled “From Root (Recommended)”# Step 1: Start the API server (Terminal 1)bun run dev:server
# Step 2: Start the web interface (Terminal 2)bun run dev:web
Access Points:
- 🌐 Web Interface:
http://localhost:6001
- 🔌 API Server:
http://localhost:8080
Benefits:
- Consistent workspace environment
- Automatic environment variable loading
- Coordinated development setup
Individual App Alternative
Section titled “Individual App Alternative”# Alternative: Start from web directorycd apps/webbun dev
Note: This method also loads the root .env
file automatically.
Verify Setup
Section titled “Verify Setup”- API Server Health: Visit
http://localhost:8080/health
- Web Interface: Open
http://localhost:6001
in your browser - Test Scraping: Try scraping
https://example.com
with normal mode
📱 Usage Guide
Section titled “📱 Usage Guide”Basic Scraping Workflow
Section titled “Basic Scraping Workflow”Step 1: Enter Target URL
Section titled “Step 1: Enter Target URL”Type or paste the website URL you want to scrape (for example):
https://anu-vue.netlify.app/guide/components/alert.html
Step 2: Select Scraping Mode
Section titled “Step 2: Select Scraping Mode”Normal Mode - For standard websites
Beast Mode - For complex applications
Step 3: Add Semantic Query (Optional)
Section titled “Step 3: Add Semantic Query (Optional)”Use natural language to specify what content you want (for example):
- “Grab code snippets & API Reference”
Step 4: Start Scraping
Section titled “Step 4: Start Scraping”Click the “Extract Content” button and watch real-time progress:
- 🔗 Connecting - Establishing connection to target site
- ⏳ Loading - Page loading and rendering
- 🧠 Analyzing - AI-powered content understanding (Beast mode)
- ⚡ Extracting - Converting to markdown format
- ✅ Complete - Content ready for use