https://github.com/kislevlevy/web-scan
Web Scan is a website scanner that gathers metadata using Django, React, and HTTPX (ProjectDiscovery). Simple UI to start scans and view results.
https://github.com/kislevlevy/web-scan
django fullstack react scanner webapp
Last synced: about 2 months ago
JSON representation
Web Scan is a website scanner that gathers metadata using Django, React, and HTTPX (ProjectDiscovery). Simple UI to start scans and view results.
- Host: GitHub
- URL: https://github.com/kislevlevy/web-scan
- Owner: kislevlevy
- Created: 2025-03-06T08:27:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-06T08:48:07.000Z (over 1 year ago)
- Last Synced: 2025-03-06T09:37:20.157Z (over 1 year ago)
- Topics: django, fullstack, react, scanner, webapp
- Language: TypeScript
- Homepage:
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://docs.docker.com/get-docker/)
- [Python](https://www.python.org/downloads/)
- [Node.js](https://nodejs.org/)
### Clone the Repository
```sh
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](https://pip.pypa.io/en/stable/installation/)
- [venv](https://virtualenv.pypa.io/en/latest/installation/)
2. Run the following commands:
```sh
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
```sh
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