README ΒΆ

jive-search logo


Jive Search is the open source search engine that doesn't track you. Search privately, now : https://jivesearch.com



πŸ’Ύ Installation

go get -u github.com/jivesearch/jivesearch
JIVESEARCH_YANDEX_USER="" && JIVESEARCH_YANDEX_KEY="" && JIVESEARCH_PIXABAY_KEY=""
cd ~/go/src/github.com/jivesearch/jivesearch/frontend && go run ./cmd/frontend.go --debug=true --provider=yandex --images_provider=pixabay

A Yandex user/API key can be obtained here: https://tech.yandex.com/xml/

A Pixabay API key can be obtained here: https://pixabay.com/api/docs/

Other API keys and settings can likewise be set via environment variables: https://github.com/jivesearch/jivesearch/blob/master/config/config.go

For production usage see https://github.com/jivesearch/jivesearch/blob/bcf9c1e6e52cd2bc9fe7e97982509fe8288b41dc/README.md


πŸš€ Roadmap

Our goal is to create a search engine that respects your privacy AND delivers great search results, instant answers, maps, image search, news, and more.

Marked items indicate progress has been made in that category. There is much more to do in each area. Suggestions are welcome!

  • Privacy
  • !Bangs
  • Core Search Results & Distributed Crawler
    • Advanced Search (exact phrase, dogs OR cats, -cats, site/domain search, etc.)
    • Filetype search
    • Language & Region
    • Phrase Suggester (a.k.a. "Did You Mean?")
    • Proxy Links
    • SafeSearch
    • Time Search (past year/month/day/hour, etc.
    • 3rd party search providers
      • Yandex API
  • Autocomplete
  • Instant Answers
    • Birthstone, camelcase, characters, coin toss, frequency, POTUS, prime, random, reverse, stats, user agent, etc.
    • Breach (a.k.a. have i been pwned)
    • Discography/Music albums
    • Economic stats (GDP, population)
    • Flight Info & Status
    • JavaScript-based answers
      • Basic calculator
        • Mortgage, financial and other calculators
      • CSS/JavaScript/JSON/etc minifier and prettifier
      • Converters (foreign exchange, meters to feet, mb to gb, etc...)
    • Maps
    • Nutrition
    • Package Tracking (UPS, FedEx, USPS, etc...)
    • Shopping
    • Stack Overflow
    • Stock Quotes & Charts
    • Weather
    • WHOIS
    • Wikipedia summary
    • Wikidata answers (how tall is, birthday, etc.)
    • Wikiquote
    • Wiktionary
    • Many more instant answers (including from 3rd party APIs)
    • Translate trigger words and answers to other languages
  • Image Search
  • Video Search
  • News
  • Custom CSS Themes
  • Tor

πŸ“™ Documentation

Jive Search's documentation is hosted on GoDoc Page here.


πŸ’¬ Contributing

Want to contribute? Great!

Search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue here.

You can also join us on Slack or contact us on Twitter @jivesearch.


Code and documentation copyright 2018 the Jive Search Authors. Code and docs released under the Apache License.

Directories ΒΆ

Path Synopsis
Package bangs provides functionality to query other websites
Package bangs provides functionality to query other websites
Package config handles configuration settings
Package config handles configuration settings
Package frontend provides the routing and middleware for the web app
Package frontend provides the routing and middleware for the web app
cache
Package cache provides simple caching mechanisms
Package cache provides simple caching mechanisms
cmd
Command frontend demonstrates how to run the web app
Command frontend demonstrates how to run the web app
Package instant provides instant answers
Package instant provides instant answers
breach
Package breach checks for data breaches for a given account
Package breach checks for data breaches for a given account
congress
Package congress retrieves members of the United States Congress
Package congress retrieves members of the United States Congress
currency
Package currency fetches foreign exchange quotes
Package currency fetches foreign exchange quotes
discography
Package discography fetches artist discography
Package discography fetches artist discography
econ/gdp
Package gdp retrieves gdp data
Package gdp retrieves gdp data
econ/population
Package population retrieves population data
Package population retrieves population data
location
Package location fetches geolocation data
Package location fetches geolocation data
nutrition
Package nutrition provides food nutrition information
Package nutrition provides food nutrition information
parcel
Package parcel shows package status for UPS, Fedex and others
Package parcel shows package status for UPS, Fedex and others
shortener
Package shortener shortens urls
Package shortener shortens urls
stackoverflow
Package stackoverflow fetches stackoverflow data
Package stackoverflow fetches stackoverflow data
status
Package status checks if a website is down
Package status checks if a website is down
stock
Package stock fetches stock quote data
Package stock fetches stock quote data
timezone
Package timezone retrieves timezone info from lat/lon coordinates
Package timezone retrieves timezone info from lat/lon coordinates
weather
Package weather fetches weather data
Package weather fetches weather data
whois
Package whois fetchers WHOIS information for a domain
Package whois fetchers WHOIS information for a domain
wikipedia
Package wikipedia fetches Wikipedia articles Package wikipedia fetches Wikipedia articles
Package wikipedia fetches Wikipedia articles Package wikipedia fetches Wikipedia articles
wikipedia/cmd/dumper
Dumper downloads and dumps wikipedia/wikidata/wikiquotes data to a postgresql database.
Dumper downloads and dumps wikipedia/wikidata/wikiquotes data to a postgresql database.
Package log handles logging for the crawler and frontend
Package log handles logging for the crawler and frontend
Package search provides the core search results.
Package search provides the core search results.
crawler
Package crawler is a distributed web crawler.
Package crawler is a distributed web crawler.
crawler/cmd
Command crawler demonstrates how to run the crawler
Command crawler demonstrates how to run the crawler
crawler/queue
Package queue manages the queue for a distributed crawler
Package queue manages the queue for a distributed crawler
crawler/robots
Package robots handles caching robots.txt files
Package robots handles caching robots.txt files
document
Package document parses URLs and the HTML of a webpage
Package document parses URLs and the HTML of a webpage
Package suggest handles AutoComplete and Phrase Suggester (Did you mean?) queries
Package suggest handles AutoComplete and Phrase Suggester (Did you mean?) queries