mirror of
https://github.com/wahyd4/hey-search.git
synced 2026-08-08 21:05:14 +10:00
junvandCopilot
0adad147f5
OpenAPI schema now derives the server URL from the incoming request (Host header + X-Forwarded-Proto/X-Forwarded-Host for reverse proxies). Curl examples in API docs use $BASE_URL placeholder which is replaced at serve-time with the actual origin, so docs work correctly behind nginx or any reverse proxy with a custom domain. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Hey Search
A privacy-respecting metasearch engine that aggregates results from multiple search engines.
Inspired by SearXNG.
Architecture
- Backend: Python / FastAPI — async metasearch orchestrator with retry logic
- Frontend: React + Vite + TypeScript + Tailwind CSS (shadcn theming) — mobile-first UI
- Docker: Multi-stage build (Node frontend build → Python runtime)
Prerequisites
Running Locally
1. Backend
cd backend
uv sync # install dependencies
uv run uvicorn app.main:app --reload --port 8000
The API will be available at http://localhost:8000. Interactive docs:
- Swagger UI: http://localhost:8000/docs
- Redoc: http://localhost:8000/redoc
2. Frontend
cd frontend
npm install # install dependencies
npm run dev # start dev server with hot reload
The frontend dev server runs at http://localhost:5173 and proxies /api requests to the backend.
3. Docker (production)
docker build -t hey-search .
docker run -p 8000:8000 hey-search
Then open http://localhost:8000.
API Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/search?q=&category= |
Search web or images |
| GET | /api/autocomplete?q= |
Autocomplete suggestions |
| GET | /api/engines |
List all search engines |
| PUT | /api/engines/{name} |
Enable/disable an engine |
Features
See FEATURES.md for the full feature list.