Skip to content

Commit

Permalink
add sections in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
harshdM99 committed Jan 20, 2025
1 parent 148b202 commit 30e87ac
Showing 1 changed file with 73 additions and 1 deletion.
74 changes: 73 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,76 @@ A project designed to crawl the dark web to extract Bitcoin wallet addresses and
1. Clone this repository:
```bash
git clone <repository-url>
cd DarkWebCryptoHunter
cd DarkWebCryptoHunter

2. Install Python dependencies:
```bash
pip install -r requirements.txt
3. Configure the project:
- Update the `config.py` file with the following:
- **TOR_PATH**: Path to your Tor browser.
- **DB_NAME**: Name of the MongoDB database.
- **URL**: Seed `.onion` URL for the crawler.
4. Start MongoDB:
```bash
mongod --dbpath <your-db-path>


## Usage

### Start Crawling
Run the `main.py` script to initiate the crawling process:
```bash
python backend/main.py
```
### Visualize Data
Open the frontend:
```bash
cd frontend
open index.html
```

### The Graph Displays:
- **Nodes**: Bitcoin wallet addresses.
- **Edges**: Transactions between addresses.

## **Directory Structure**

```plaintext
DarkWebCryptoHunter/
├── frontend/ # Frontend for visualization
│ ├── index.html # Main webpage
│ ├── css/
│ │ └── style.css # Styles for the website
│ ├── js/
│ │ └── script.js # Logic for graph visualization
│ └── assets/
│ └── images/ # Images and static assets
├── backend/ # Backend for crawling and processing data
│ ├── crawler.py # Dark web crawler
│ ├── database.py # Handles database operations
│ ├── bitcoin_address_extractor.py # Extracts Bitcoin addresses from raw data
│ ├── config.py # Configuration constants
│ └── main.py # Entry point for backend logic
└── README.md # Project documentation
```

## **Further Development**
While the current implementation provides static data visualization, the following enhancements can be added:

### **Dynamic Data Fetching**
- Integrate the frontend with the backend to dynamically fetch Bitcoin transaction data for any wallet address.

### **Real-Time Crawling**
- Enable live crawling of the dark web for updated Bitcoin transaction data.

### **Advanced Analytics**
- Add statistical analysis features to identify suspicious patterns automatically.

### **Depth Customization**
- Allow users to customize the depth of transaction analysis in the graph.

0 comments on commit 30e87ac

Please sign in to comment.