mirror of
https://github.com/mblanke/ThreatHunt.git
synced 2026-03-01 14:00:20 -05:00
post CLAUDE updates
had CLAUDE AI made suggestions and edits to code. added all route and moves some requirements around.
This commit is contained in:
69
README.md
69
README.md
@@ -1,4 +1,65 @@
|
||||
# Velo Threat Hunter UI v2
|
||||
- React + Flask + Tailwind
|
||||
- Sidebar layout with icons
|
||||
- Ready to extend
|
||||
# Velo Threat Hunter
|
||||
|
||||
A modern web application for threat hunting and security analysis, built with React frontend and Flask backend.
|
||||
|
||||
## Features
|
||||
|
||||
- **Security Tools Detection**: Identify running security tools (AV, EDR, VPN)
|
||||
- **CSV Processing**: Upload and analyze security logs
|
||||
- **Baseline Analysis**: System baseline comparison
|
||||
- **Network Analysis**: Network traffic and connection analysis
|
||||
- **VirusTotal Integration**: File and URL reputation checking
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
ThreatHunt/
|
||||
├── frontend/ # React application
|
||||
├── backend/ # Flask API server
|
||||
├── uploaded/ # File upload storage
|
||||
└── output/ # Analysis results
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Backend Setup
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
chmod +x setup_backend.sh
|
||||
./setup_backend.sh
|
||||
source venv/bin/activate
|
||||
python app.py
|
||||
```
|
||||
|
||||
### Frontend Setup
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## API Endpoints
|
||||
|
||||
- `GET /` - Serve React app
|
||||
- `GET /api/health` - Health check
|
||||
- `POST /api/upload` - File upload
|
||||
- `GET /api/analysis/<id>` - Get analysis results
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- File upload validation
|
||||
- Input sanitization
|
||||
- Rate limiting
|
||||
- CORS configuration
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create feature branch
|
||||
3. Submit pull request
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Reference in New Issue
Block a user