Git Product home page Git Product logo

showcase-xkcd-search's Introduction

xkcd search

This is a demo that showcases some of Typesense's features using xkcd comics and metadata from explain xkcd.

View it live here: https://findxkcd.com/

Tech Stack

This search experience is powered by Typesense which is a fast, open source typo-tolerant search-engine. It is an open source alternative to Algolia and an easier-to-use alternative to ElasticSearch.

The app was built using the Typesense Adapter for InstantSearch.js and is hosted on Cloudflare Pages.

The search/browsing backend is powered by a geo-distributed 3-node Typesense cluster running on Typesense Cloud, with nodes in Oregon, Frankfurt and Mumbai.

Repo structure

  • src/ and index.html - contain the frontend UI components, built with Typesense Adapter for InstantSearch.js
  • scripts/ - contains the scripts to extract, transform and index the data into Typesense.

Development

  1. Create a .env file using .env.example as reference.

  2. Fetch Data

mkdir -p data/raw
yarn fetchData
  1. Transform and index the data
yarn transformData
yarn indexData
  1. Install dependencies and run the local server:
yarn
yarn start

Open http://localhost:3000 to see the app.

Update data

# Delete cached files that might not have had explanations during previous run
find data/raw -name "*.html" -type f -exec grep -l "explanation may be incomplete" {} + | xargs -r rm
yarn fetchData

# Handle 503s
find data/raw -name "*.html" -type f -exec grep -l "server is temporarily unable" {} + | xargs -r rm
find data/raw -name "*.json" -type f -exec grep -l "<html>" {} + | xargs -r rm

# Refresh and index
yarn refreshData

Deployment

The app is hosted on Cloudflare Pages and is set to auto-deploy on git push

showcase-xkcd-search's People

Contributors

jasonbosco avatar phihero avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.