|
| 1 | +# ThreatCrush Browser Extension |
| 2 | + |
| 3 | +MV3 extension built with Vite + React 19 + Tailwind. **Status:** dev preview. Sideload-from-source works today; store submissions happen post-launch. |
| 4 | + |
| 5 | +## Dev |
| 6 | + |
| 7 | +```bash |
| 8 | +# from repo root |
| 9 | +pnpm install |
| 10 | +cd apps/extension |
| 11 | +pnpm dev # vite dev server for popup/options |
| 12 | +``` |
| 13 | + |
| 14 | +## Build |
| 15 | + |
| 16 | +Per-browser builds via `scripts/build.js`: |
| 17 | + |
| 18 | +```bash |
| 19 | +pnpm build # → dist/chrome, dist/firefox, dist/safari |
| 20 | +node scripts/build.js chrome |
| 21 | +node scripts/build.js firefox |
| 22 | +node scripts/build.js safari |
| 23 | +node scripts/build.js all |
| 24 | +``` |
| 25 | + |
| 26 | +## Sideload (while stores are pending) |
| 27 | + |
| 28 | +**Chrome / Edge:** |
| 29 | +1. `pnpm build` and open `chrome://extensions` |
| 30 | +2. Enable *Developer mode* |
| 31 | +3. *Load unpacked* → select `apps/extension/dist/chrome/` |
| 32 | + |
| 33 | +**Firefox:** |
| 34 | +1. Open `about:debugging#/runtime/this-firefox` |
| 35 | +2. *Load Temporary Add-on* → select `apps/extension/dist/firefox/manifest.json` |
| 36 | + |
| 37 | +**Safari:** |
| 38 | +Requires Xcode to convert to a Safari Web Extension bundle. See Apple's [Safari Web Extensions docs](https://developer.apple.com/documentation/safariservices/safari_web_extensions). |
| 39 | + |
| 40 | +## Features |
| 41 | + |
| 42 | +- Scan any site (security headers, mixed content, basic checks) |
| 43 | +- Real-time alert popup when a ThreatCrush server emits a critical event |
| 44 | +- Dashboard popup — recent events + module status |
| 45 | + |
| 46 | +## Structure |
| 47 | + |
| 48 | +``` |
| 49 | +apps/extension/ |
| 50 | +├── manifest.json MV3 manifest (per-browser variants in src/manifests/) |
| 51 | +├── src/ |
| 52 | +│ ├── background/ Service worker |
| 53 | +│ ├── popup/ React popup UI |
| 54 | +│ ├── options/ React options page |
| 55 | +│ ├── content/ Content scripts |
| 56 | +│ └── store/ Zustand stores (shared) |
| 57 | +└── scripts/build.js Per-browser packager |
| 58 | +``` |
| 59 | + |
| 60 | +## Store submission (post-launch) |
| 61 | + |
| 62 | +Each store has its own review process: |
| 63 | +- **Chrome Web Store** — requires dev fee, screenshots, privacy policy, scope justification |
| 64 | +- **Firefox AMO** — free; source review if minified |
| 65 | +- **Safari** — App Store Connect, Apple Developer membership required |
| 66 | + |
| 67 | +None submitted yet. |
0 commit comments