Spaces:
Running
LinkScout - Complete Setup Guide
Smart Analysis. Simple Answers.
This guide will help you set up and run the complete LinkScout system with both the web interface and browser extension.
π― System Overview
LinkScout consists of three main components:
- Python Backend Server (
combined_server.py) - Handles all AI analysis - Browser Extension (
extension/) - Analyze articles directly in your browser - Web Interface (
web_interface/LinkScout/) - Modern web app for analysis
Important: All three components share the same backend server!
π Prerequisites
Required Software
- Python 3.10+
- Node.js 18+ and npm
- Modern Browser (Chrome, Edge, Firefox)
Required Python Packages
All listed in requirements.txt. Install with:
pip install -r requirements.txt
π Quick Start (3 Steps)
Step 1: Start the Backend Server
This is REQUIRED for both the extension and website to work.
cd d:\LinkScout
python combined_server.py
Wait for:
β
Server running on http://localhost:5000
Step 2: Option A - Use the Browser Extension
- Open your browser (Chrome/Edge)
- Navigate to
chrome://extensions/ - Enable "Developer mode"
- Click "Load unpacked"
- Select
d:\LinkScout\extension\ - Click the LinkScout icon to analyze any webpage!
Step 2: Option B - Use the Web Interface
# In a NEW terminal
cd d:\LinkScout\web_interface\LinkScout
npm install # First time only
npm run dev
Open browser to: http://localhost:3000
Step 3: Analyze Content!
Extension:
- Click the extension icon
- Click "Scan Page" to analyze current page
- Or paste URL/text and click "Analyze"
Website:
- Go to Search page (
/search) - Paste URL or text
- Press Enter
π Directory Structure
d:\LinkScout\
βββ combined_server.py # βοΈ BACKEND SERVER (must be running)
βββ extension/ # π§© BROWSER EXTENSION
β βββ manifest.json
β βββ popup.html
β βββ popup.js
β βββ background.js
β βββ content.js
β βββ styles.css
βββ web_interface/
βββ LinkScout/ # π WEB INTERFACE
βββ app/
β βββ page.tsx # Home page
β βββ search/ # Analysis page
β βββ extensions/ # Extension download
β βββ api/ # API routes
βββ components/
βββ package.json
π§ How It Works
Browser Extension β
β
Backend Server (Port 5000)
β
Web Interface β
Both the extension and website send requests to the same backend server which:
- Analyzes content with 8 ML models
- Uses Groq AI for intelligent insights
- Runs 8-phase Revolutionary Detection
- Returns comprehensive analysis results
π Features
Backend Server (combined_server.py)
β
Groq AI Agentic System (4 Agents)
β
Pre-trained Models (8 Models)
β
Custom Trained Model
β
Revolutionary Detection (8 Phases)
β
Category/Label Detection
β
Google Search Integration
β
Reference Links & Sources
β
Image Analysis (AI-generated detection)
β
Reinforcement Learning
Browser Extension
β
Analyze current page with one click
β
Paste URL or text for analysis
β
Highlight suspicious paragraphs
β
Real-time credibility scoring
β
Detailed breakdown by section
β
Source verification
Web Interface
β
Modern, responsive UI
β
Real-time analysis
β
Beautiful results display
β
Extension download page
β
Mobile-optimized
β
Dark mode theme
π Web Interface Pages
/- Home page with hero/search- Main analysis interface β/extensions- Download extension β/history- Analysis history (placeholder)/settings- Settings (placeholder)
π― Use Cases
Use Case 1: Check News Article via Extension
- Navigate to any news article
- Click LinkScout extension icon
- Click "Scan Page"
- View inline highlights + detailed analysis
Use Case 2: Analyze URL via Website
- Go to
http://localhost:3000/search - Paste article URL
- Press Enter
- View comprehensive analysis
Use Case 3: Check Suspicious Text
- Copy suspicious text
- Open extension OR website
- Paste text
- Get instant credibility score
Use Case 4: Download Extension from Website
- Go to
http://localhost:3000/extensions - Click "Download Extension"
- Extract ZIP file
- Load into browser
π Troubleshooting
Backend Server Won't Start
Error: ModuleNotFoundError
Solution:
pip install -r requirements.txt
Error: Port 5000 already in use
Solution: Kill process using port 5000 or change port in combined_server.py
Extension Not Working
Error: "Server offline"
Solution: Make sure backend server is running (python combined_server.py)
Error: "No content found"
Solution: Try clicking "Scan Page" instead of analyzing current URL
Website Not Loading
Error: npm: command not found
Solution: Install Node.js from https://nodejs.org/
Error: "Failed to analyze content"
Solution: Ensure backend server is running on port 5000
Analysis Taking Too Long
Normal: First analysis loads models (30-60 seconds)
Subsequent: Should be faster (10-20 seconds)
If still slow, check:
- GPU drivers (if using CUDA)
- Internet connection (for Groq AI)
- Server console for errors
π Important Notes
- Backend MUST be running for both extension and website
- First analysis is slow (models loading) - be patient!
- Groq API may have rate limits - fallback to ML models if needed
- Extension and website are independent - use either or both!
π Configuration
Backend Server Port
Change in combined_server.py:
app.run(host='0.0.0.0', port=5000) # Change 5000 to desired port
Website Backend URL
Change in web_interface/LinkScout/.env.local:
NEXT_PUBLIC_BACKEND_URL=http://localhost:5000
Extension Backend URL
Change in extension/popup.js:
const SERVER_URL = 'http://localhost:5000';
π Production Deployment
Backend
# Use gunicorn for production
pip install gunicorn
gunicorn combined_server:app -w 4 -b 0.0.0.0:5000
Web Interface
cd web_interface/LinkScout
npm run build
npm run start
Extension
- Create production build (if using build tools)
- Package as ZIP
- Submit to Chrome Web Store / Edge Add-ons
π Getting Help
Check Logs
Backend: Console where you ran python combined_server.py
Website: Browser DevTools β Console
Extension: Chrome β Extensions β LinkScout β Inspect views
Common Issues
β
"Server offline" β Start combined_server.py
β
"Analysis failed" β Check backend console for errors
β
"No results" β Try different content or check internet
β
Page not loading β Clear browser cache, restart servers
π You're All Set!
You now have:
- β Backend server running AI analysis
- β Browser extension for quick checks
- β Modern web interface for detailed analysis
- β Extension download capability
Start analyzing content and fighting misinformation! π
Questions? Check the server console for detailed logs.
Found a bug? Check backend + browser console for errors.
Made with β€οΈ for truth and accuracy.