vixkram/OSINTBox-data
GitHub: vixkram/OSINTBox-data
Stars: 70 | Forks: 9
# 🔍 OSINTBox Data
[](https://github.com/vixkram/OSINTBox-data/actions)
[](#-contribute)
[](LICENSE)
## 📁 Repository Structure
├── 📄 tools.json # Core categories and tools
├── ⚙️ widgets.json # Widget configuration
└── 📋 schema/ # JSON schemas for validation
├── tools.schema.json
└── widgets.schema.json
### 🔧 File Descriptions
| File | Status | Description |
|------|--------|-------------|
| `tools.json` | **Required** | Main database of OSINT tools organized by categories |
| `widgets.json` | *Optional* | Configuration for dashboard widgets (world clock, feeds, etc.) |
## 🤝 Contribute
### 📝 Quick Start
1. **Fork** this repository
2. **Edit** `tools.json` (and `widgets.json` if needed)
3. **Open** a Pull Request
4. **Wait** for automated validation to pass
### ✅ Local Validation (Optional)
# 1. Install validation tools
npm i -D ajv-cli@5
# 2. Validate your changes
npx ajv validate -s schema/tools.schema.json -d tools.json --all-errors
# 3. Validate widgets (if modified)
if [ -f widgets.json ]; then
npx ajv validate -s schema/widgets.schema.json -d widgets.json --all-errors
fi
## 📊 Data Schema
### 🛠️ Tool Object
{
"name": "Tool Name",
"url": "https://example.com"
// Optional overrides:
// "description": "Brief description",
// "icon": "https://example.com/favicon.ico"
}
### 📂 Category Object
{
"category": "Category Name",
"tools": [
// Array of tool objects
]
}
## 💡 Best Practices
### ✏️ Writing Guidelines
- **Descriptions**: Only include if they add clear value beyond the tool name (otherwise omit)
- **Icons**: Usually omit — the UI auto‑generates favicons from the tool domain. Only set `icon` to override.
- Do not use third‑party proxies; if needed, use a direct image URL (e.g., the site’s real favicon).
- **URLs**: Ensure all links are active and lead to canonical pages; remove tracking params
### 🎯 Quality Standards
- ✅ Verify tool functionality before adding
- ✅ Use clear, descriptive names
- ✅ Categorize appropriately
- ✅ Test all URLs
## 🚀 Getting Started
1. **Browse** the `tools.json` file to see existing categories and tools
2. **Identify** gaps or new tools to add
3. **Follow** the schema structure
4. **Submit** your contribution via Pull Request
## 🙏 Acknowledgments