Search/README.md

51 lines
No EOL
1.3 KiB
Markdown

# This projet is WIP
## Completed Tasks
- [x] Text results
- [x] Image results
- [X] Video results
- [X] Map results
- [X] Forums results
- [x] HTML+CSS site (no JS version)
- [X] Results cache
- [X] Torrent results
## Pending Tasks
- [ ] Website with JS version
- [ ] JS applets for results (such as calculator)
- [ ] Dynamic results loading as user scrolls
- [ ] Replace fonts, replace icons font for SVG or remove unnecessary icons for faster loading
- [ ] Better name
- [ ] LXC container
- [ ] Docker container
# Go Search Engine
A self-hosted [metasearch engine](https://en.wikipedia.org/wiki/Metasearch_engine) that respects privacy, contains no ads, and serves as a proxy/alternative to Google website.
## Features
- Text search using Google search results.
- Image search using the Qwant API.
- Video search using Piped API.
- Image viewing using proxy and direct links to image source pages for image searches.
- Maps using OpenStreetMap
- Files download using torrent sites.
## Getting Started
### Prerequisites
- Go (version 1.18 or higher recommended)
- Access to the internet for fetching results from the Qwant API and Google
### Running the Application
```bash
git clone https://weforgecode.xyz/Spitfire/Search.git
cd Search
chmod +x ./run.sh
./run.sh
```