Web Scan 🔍

A modern website scanning application that allows users to enter a URL, initiate a scan, and retrieve metadata such as hosting details, technologies used, and server response.

Features

• Scan websites for metadata: IP addresses, web server type, HTTP status, technologies
• Uses HTTPX by ProjectDiscovery for deep scanning
• React + Vite frontend with an intuitive UI

Tech Stack

Layer	Technology	Description
Backend	Python + Django	API and server logic
	HTTPX (ProjectDiscovery)	CLI-based web scanner
Frontend	Vite + React (TS)	Frontend framework
	TailwindCSS + ShadCN UI	Styling and UI components
	React Context API	State management
	Axios	API requests

Installation & Setup

Prerequisites

Ensure you have the following installed:

• Docker
• Python
• Node.js

Clone the Repository

git clone https://github.com/kislevlevy/web-scan
cd web-scan

Setup Environment Variables

Follow the .env.md file instructions to configure backend/.env and frontend/.env.

Running the Application

Backend

1. Ensure you have:

   • pip
   • venv

2. Run the following commands:

   cd backend
   python --version  # Verify Python installation
   
   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt
   python manage.py runserver

Backend runs on: http://localhost:8000

Frontend

cd frontend
npm -v  # Verify NPM installation

npm install
npm run dev

Frontend runs on: http://localhost:5173

How to Use

1. Open the web application
2. Enter a valid website URL
3. Press Enter or click Search
4. Wait for the scan to complete
5. Only found metadata will be displayed

   Example: If no CNAME records exist, that section won't appear