search-ui

search-ui

This is an experimental UI for searching my StackOverflow up-voted posts using Algolia.

Instructions

Follow these instructions to build and run the UI:

1. Pre-requisite: Node.js
   • I used version 18.17.1
2. Install dependencies:

   • npm install

3. Serve and continuously build the site with the development server:

   • npm run dev

4. Open the page and try it out
   • Open the browser to http://localhost:3000.

Special Instructions

To build the site for deployment to GitHub Pages, use a special environment variable. The build command looks like this:

npm run build-target-gh-pages

To point the app to a local Lucene-based API implemented the search-api/ project, add a special environment variable like this:

NEXT_PUBLIC_SEARCH_CLIENT=search-api npm run dev

Wish List

General clean-ups, TODOs and things I wish to implement for this project:

• Facet search. This requires understanding the Algolia API's support for facets, mocking it in search-api, and then doing the frontend changes. There should be some nice React components for it already.

Reference

• Algolia
• Algolia docs: Using UI widgets
• Next.js docs: Environment Variables
• Algolia API reference: Search Multiple Indices
  • This shows an example JSON response.