Skip to content

A new take on the Middle English Dictionary

Notifications You must be signed in to change notification settings

mlibrary/dromedary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dromedary -- Middle English Dictionary Application

A new(-ish, these days) discovery system for the Middle English Dictionary.

Confusingly, there are three separate repositories:

  • dromedary, this repo, is the Rails application. The name was given the project when someone decided we should start naming project with nonsense words.
  • middle_english_dictionary is not, as one might expect, the Middle English Dictionary code. Instead, it's the code that pulls out indexable data from each little XML file, inserts things like links to the OED and DOE, and serves as the basis for building solr documents.
  • middle-english-argocd(private) is the argocd setup which deals with environment variables and secrets, and serves to push the application to production. It also has a small-but-valid .zip file under the sample_data directory.

Documentation

  • Setting up a development environment runs through how to get the docker-compose-based dev environment off the ground and index some data into its local solr.
  • Overview of indexing talks about what the indexing process does, where the important files are, and what code might be interesting.
  • Configuration does a very brief run through the important ENV values. In general, the compose.yml file, the argocd repository, and especially lib/dromedary/services.rb will be the best place to see what values are available to change. Don't do that unless you know what you're doing, though.
  • Solr setup looks at the interesting bits of the solr configuration, in particular the suggesters (for autocomplete).
  • Tour of the application code is a quick look at how the MED differs from a stock Rails application.

Access links

About upgrading

This repo currently runs on Ruby 2.x and Blacklight 5.x, and there are no plans to upgrade either.

docker-compose up -d

Note that there's no data in it yet, so lots of actions will throw errors. It's time to index some data.