mirror of
https://github.com/wahyd4/hey-search.git
synced 2026-08-09 05:06:23 +10:00
junvandCopilot
7a2126ddb1
- Add LICENSE (GNU Affero General Public License v3.0) - Add NOTICE file with SearXNG attribution for borrowed scraping patterns in google.py (arc_id, GSA user-agent, HTML selectors) and bing.py (PERE pagination, base64 redirect decoding, CAPTCHA detection) - Add CONTRIBUTING.md with contribution guidelines and license info - Add SPDX-License-Identifier headers to all Python source files - Add AGPL-3.0 license badge and License section to README.md SearXNG is licensed under AGPL-3.0-or-later; this project follows suit as it incorporates techniques derived from SearXNG's search engines. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
27 lines
713 B
Markdown
27 lines
713 B
Markdown
# Contributing to Hey Search
|
|
|
|
Contributions are welcome! Keep it simple — open an issue or a PR.
|
|
|
|
By contributing, you agree your changes will be licensed under [AGPL-3.0](LICENSE).
|
|
|
|
## Running Locally
|
|
|
|
```bash
|
|
# Backend
|
|
cd backend && uv sync
|
|
uv run uvicorn app.main:app --reload --port 8000
|
|
|
|
# Frontend
|
|
cd frontend && npm install && npm run dev
|
|
```
|
|
|
|
## Adding a Search Engine
|
|
|
|
1. Create `backend/app/engines/<name>.py` implementing `SearchEngine`
|
|
2. Register it in `backend/app/engines/registry.py` → `load_default_engines()`
|
|
|
|
## Notes
|
|
|
|
- If you borrow scraping techniques from another open-source project, add an inline comment and an entry to `NOTICE`
|
|
- Update `CHANGELOG.md` if your change is user-facing
|