Skip to content

Latest commit

 

History

History
157 lines (118 loc) · 6.06 KB

README.md

File metadata and controls

157 lines (118 loc) · 6.06 KB
Raw

quote-hero 💬

Searching Wikiquote with Elasticsearch

Table of Contents
  1. About
  2. Getting Started
  3. Usage
  4. License

About

product-screenshot

quote-hero is a game where you attempt to match as many Wikiquote pages as possible using random words. Adding more words gives you a higher score, but is risky because you may not match any pages. Depending on how confident you are in your set of words you can choose an exact match or a forgiving match.

quote-hero is made up of several applications orchestrated with Docker Compose:

  • A single node Elasticsearch cluster is used to search for matching Wikiquote pages.
  • The ingest process creates an ElasticSearch index and populates it with the most recent dump published by Wikiquote.
  • The api returns random words (using the top 10,000 most frequent english language words), and returns the matching pages.
  • The frontend allows users play quote-hero
  • An nginx reverse proxy serves the frontend and api.

(back to top)

Built With

Elasticsearch Python FastAPI React TailwindCSS Vite Docker Nginx

(back to top)

Getting Started

Installation is easy thanks to docker compose, you just need to clone this repository then run the up command.

Prerequisites

Docker Compose must be installed on your machine. It can be installed through docker desktop or docker engine.

Installation

  1. Clone this repo 
    git clone https://github.com/beakerandjake/quote-hero
  2. Start the application 
    docker compose up -d

To stop the application

docker compose down

Note

Depending on your computer and internet connection it may take a while for the application to start up. The ingest process particularly may take a long time, it must download a very large Wikiquote dump file and then load that data into Elasticsearch. However this ingest process only occurs the first time you start the project.

To check on the progress of the ingest you can run the following command once the ingest container is running:

docker logs --follow ingest

(back to top)

Usage

After the project is running navigate to http://localhost:8080 in your browser.

How To Play

  1. Click the "Add Word" button to get a random word.
  2. Now you must decide if you want to keep adding words or to use the words you have. Keep in mind you cannot delete words, once you add a word you are stuck with it.
  3. Once you are satisfied with your words you have to choose how you want to match:
    • If you are confident in your words you can click the Match Exact button. This will match any pages with the exact phrase formed by the words.
    • Otherwise you can click the Match Forgiving button, this is a more lenient search. It finds any pages which contains all of the words at least once somewhere on the page.
    • Note: If you only have one word you are only presented with one match button which performs an exact match.
  4. At any time you can click the Reset button to clear your words and the results and start over.

The goal is to use as many words as possible to match as many pages as possible.

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)