geolexica / isotc211.geolexica.org

ISO/TC 211 online version of the Multi-Lingual Glossary of Terms
https://isotc211.geolexica.org
4 stars 2 forks source link

Add beta page for "breviter" reverse semantic search #174

Closed ronaldtse closed 1 year ago

ronaldtse commented 1 year ago

(as per https://github.com/geolexica/breviter/issues/9 )

Breviter is the new Geolexica approach to reverse semantic search (https://github.com/geolexica/breviter).

The Breviter site is developed using Next.js and we wish to add a tab + page on isotc211.geolexica.org :

Screen Shot 2022-09-27 at 11 50 24 AM

Please follow the instructions on the Breviter repository on how to run it.

Breviter does not require any server to be run. The pages and content can all be served in a static manner, including the models (that are sharded in multiple files), the database (prepared into a public/db.json file), and the JS.

ronaldtse commented 1 year ago

Steps necessary:

  1. Ensure you can test out Breviter locally
  2. Import the results of Breviter's build (yarn build) into isotc211.geolexica.org's Jekyll build. This can be via a submodule or other mechanisms. Notice that Breviter directly incorporates the isotc211-concepts dataset via a submodule. We need to decompose that. Also, Breviter depends on a "public/db.json" file built from a "concept dataset".
  3. We need to change the Breviter results to provide "links" to the corresponding concepts on isotc211.geolexica.org.
  4. The presentation is of low importance (i.e. applying the Geolexica style is not important)
HassanAkbar commented 1 year ago

@ronaldtse @ribose-jeffreylau From what I understand I have to do the following steps:

  1. Add Breviter as a submodule into the isotc211.geolexica.org repo
  2. Add steps in the makefile to yarn build and yarn start for Breviter. ( Once there is a command to build db.json file we can add that to makefile as well).
  3. Convert the name of the returned items from Breviter into links to isotc211.geolexica.org concept.

Is this correct or am I going in a different direction?

ribose-jeffreylau commented 1 year ago

@HassanAkbar There's now a PR that implements the db.json generation command @ https://github.com/geolexica/breviter/pull/13/ . The command is yarn compute_db, which would create a new public/db.json (replaces the original one in the repo if it still exists).

ronaldtse commented 1 year ago

@HassanAkbar it is correct except for step 2. Once we do yarn build we already get the static site, we do not need to run yarn start which starts the node server (that serves the site built from yarn build).