linkscout-backend / QUICK_REFERENCE.md
zpsajst's picture
Initial commit with environment variables for API keys
2398be6

LinkScout - Quick Reference πŸš€

⚑ Quick Start (2 Commands)

1. Start Backend (REQUIRED)

python combined_server.py

Wait for: βœ… Server running on http://localhost:5000

2. Start Website (Optional)

cd web_interface\LinkScout
npm run dev

Open: http://localhost:3000


πŸ“ URLs & Ports

Component URL Port
Backend Server http://localhost:5000 5000
Web Interface http://localhost:3000 3000
Extension chrome://extensions/ N/A

🎯 Main Features

Web Interface Pages

  • / - Home page
  • /search - Analyze URLs/text ⭐
  • /extensions - Download extension ⭐
  • /history - Past analyses
  • /settings - Settings

Extension Features

  • Analyze current page
  • Paste URL/text
  • Highlight suspicious content
  • Real-time scoring

πŸ”§ Common Tasks

Analyze a URL

Website: Go to /search β†’ Paste URL β†’ Enter
Extension: Click icon β†’ Paste URL β†’ Analyze

Download Extension

Website: Go to /extensions β†’ Click Download
Manual: Load d:\LinkScout\extension in browser

Check Backend Status

Test: Open http://localhost:5000/health
Should see: {"status": "healthy", ...}


πŸ› Troubleshooting

Problem Solution
"Server offline" Run python combined_server.py
"Analysis failed" Check backend console for errors
Port 5000 in use Kill process or change port
Extension not working Restart backend server
Website won't start Run npm install first

πŸ“‚ Important Files

File Purpose
combined_server.py Backend server ⭐
extension/ Browser extension ⭐
web_interface/LinkScout/ Web app ⭐
START_BACKEND.bat Quick backend start
START_WEBSITE.bat Quick website start

🎨 Key Components

Backend API Endpoints

  • /api/v1/analyze-chunks - Main analysis
  • /health - Health check
  • /download-extension - Extension ZIP

Web API Routes

  • /api/analyze - Analysis proxy
  • /api/health - Health proxy
  • /api/download-extension - Download proxy

πŸ’‘ Tips

βœ… Always start backend first
βœ… First analysis is slow (models loading)
βœ… Keep backend terminal open
βœ… Extension and website work independently
βœ… Both use the same backend server


πŸ“ž Need Help?

  1. Check backend console for errors
  2. Check browser console (F12)
  3. Read COMPLETE_SETUP_GUIDE.md
  4. Check INTEGRATION_COMPLETE.md for details

Made with ❀️ - Smart Analysis. Simple Answers.