Search/README.md

62 lines
No EOL
2.1 KiB
Markdown

# This projet is WIP
## Completed Tasks
- [x] Text results
- [x] Image results
- [X] Video results
- [X] Map results
- [x] HTML+CSS site (no JS version)
## Pending Tasks
- [ ] Forums results
- [ ] Torrent results
- [ ] 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
- [ ] 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.
## 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
```
## Project Structure
- `main.go`: The entry point of the application, setting up the web server and routing.
- `text.go`: Handles text search requests, fetching results from Google and processing them for display.
- `images.go`: Contains logic for handling image search requests, including fetching data from the Qwant API and preparing it for the template.
- `imageproxy.go`: Part of images.go srach logic, handles image reuslts and displays them using proxy.
- `/templates`: Directory containing HTML templates for rendering the search interface and results.
- `search.html`: The main search page template.
- `text.html`: Template for displaying text search results.
- `images.html`: Template for displaying image search results.
- `videos.html`: Template for displaying video search results.
- `/static/css`: Directory for CSS stylesheets.
- `style.css`: The main stylesheet for the search interface and results.
- `/static/css`: Directory for fonts and icons (as font).