Search UI for Archives of Nethys

This project was bootstrapped with Create React App, and then implemented with Elastic Search UI.

Maintaining/Developing

This project has two main components:

1. The frontend/UI, defined by this repo
2. The backend ETL that populates the data for search

Frontend Code

This repo, at present, only has two files of note.

1. App.tsx. This is the project entrypoint. It contains the configuration for which App Search deployment to read from, which facets to display, and which component to use to display search results. As far as maintaining the project goes, this is where new facets should be added.
2. CustomResultView.tsx. This replaces Search UI's default component for search results. Any changes to how individual search results should be displayed goes here.

You can run npm run start to run the project locally to test your changes. Once they are ready, you can deploy them to github pages with npm run deploy.

Backend Code

The data that powers the search experience is gathered by Elastic's Crawler, processed through an Elasticsearch Ingest Pipeline, and then exposed through an App Search Engine. Details for the deployment and engine being used are in App.tsx. Reach out to Sean for credentials to access the deployment.

The crawler is scheduled to run a full crawl once per week. However as part of development, you may find it useful to crawl single pages at a depth of 1 in order to test changes made to the crawler extraction rules or ingest pipeline. Until #2 is complete, all changes to the crawler, engine, and pipeline must be made manually.

Available Scripts

In the project directory, you can run:

npm run start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run deploy

Deploys the UI using gh-pages to Github Pages.