Search/README.md

# 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
- [ ] Automatic updates
- [ ] Scalable crawlers and webservers + load balacing

# Ocásek (Warp) Search Engine

A self-hosted private and anonymous [metasearch engine](https://en.wikipedia.org/wiki/Metasearch_engine), that aims to be more resource effichent and scalable. Decentralized services are nice, but juming between instances when one just stops working for some reason is just inconvenient. So thats why this engine can do both, you can self-hoste it or use [officiall instance](https://search.spitfirebrowser.com/).

## Comparison to other search engines

| Name       | Works without JS     | Privacy frontend redirect | Torrent results | API | No 3rd party libs | Scalable | Not Resource Hungry                        | Dynamic Page Loading |
|------------|----------------------|---------------------------|-----------------|-----|-------------------|----------|---------------------------------------------|----------------------|
| Whoogle    | ✅                   | ❓ Only host can set it    | ❌              | ❌  | ❌                     | ❌        | ❓ Moderate                                 | ❓ Not specified      |
| Araa-Search| ❌                   | ✅                        | ✅              | ✅  | ❓                     | ❌        | ❌ Very resource hungry                     | ❌                    |
| LibreY     | ✅                   | ✅                        | ✅              | ✅  | ✅                     | ❌        | ❓ Moderate                                 | ❌                    |
| Ocásek     | ✅                   | ✅                        | ✅              | ❌  | ✅ [1]                 | ✅        | ✅ about 20MiB at idle, 21MiB when searching| ✅                    |

[1]: It does not rely on 3rd-party libs for webscraping like [Selenium](https://www.javatpoint.com/selenium-webdriver), but it uses other search instalces like LibreX as fallback.

## Features

- Text search using Google, Brave, DuckDuckGo and LibreX/Y search results.
- Image search using the Qwant/Imgur.
- 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)
- Git (unexpected)
- Access to the internet for fetching results (even more unexpected)

### Running the Application

```bash
git clone https://weforgecode.xyz/Spitfire/Search.git
cd Search
chmod +x ./run.sh
./run.sh
```

*Its that easy!*