Update README.md
This commit is contained in:
parent
842af11282
commit
6e3d77d29a
1 changed files with 64 additions and 1 deletions
65
README.md
65
README.md
|
@ -1,6 +1,27 @@
|
||||||
|
# This projet is WIP
|
||||||
|
|
||||||
|
## Completed Tasks
|
||||||
|
|
||||||
|
- [x] Text results
|
||||||
|
- [x] Image results
|
||||||
|
- [x] HTML+CSS site (no JS version)
|
||||||
|
|
||||||
|
## Pending Tasks
|
||||||
|
|
||||||
|
- [ ] Video results
|
||||||
|
- [ ] Forums results
|
||||||
|
- [ ] Map 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
|
# Go Search Engine
|
||||||
|
|
||||||
This project is a versatile search engine built with Go that leverages external APIs to fetch both image and text search results. It displays these results in a responsive web interface, offering users a comprehensive search experience.
|
A self-hosted aggregate search engine that respects privacy, contains no ads, and serves as a proxy to Google website.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
@ -38,3 +59,45 @@ go run main.go text.go images.go imageproxy.go
|
||||||
- `text.html`: (If applicable) Template for displaying text search results.
|
- `text.html`: (If applicable) Template for displaying text search results.
|
||||||
- `/static/css`: Directory for CSS stylesheets.
|
- `/static/css`: Directory for CSS stylesheets.
|
||||||
- `style.css`: The main stylesheet for the search interface and results.
|
- `style.css`: The main stylesheet for the search interface and results.
|
||||||
|
|
||||||
|
|
||||||
|
# Go Search Engine
|
||||||
|
|
||||||
|
This project is a versatile search engine built with Go that leverages external APIs to fetch both image and text search results. It displays these results in a responsive web interface, offering users a comprehensive search experience.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Text search using Google search results.
|
||||||
|
- Image search using the Qwant API.
|
||||||
|
- Responsive web interface for displaying search results with previews.
|
||||||
|
- Image viewing using proxy and direct links to image source pages for image searches.
|
||||||
|
- Display of text search results with links to source content.
|
||||||
|
|
||||||
|
|
||||||
|
## 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
|
||||||
|
go run main.go text.go images.go imageproxy.go
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
- `images.html`: Template for displaying image search results.
|
||||||
|
- `text.html`: Template for displaying text search results.
|
||||||
|
- `/static/css`: Directory for CSS stylesheets.
|
||||||
|
- `style.css`: The main stylesheet for the search interface and results.
|
||||||
|
|
Loading…
Reference in a new issue