https://github.com/mlibrary/dromedary
A new take on the Middle English Dictionary
https://github.com/mlibrary/dromedary
Last synced: 8 months ago
JSON representation
A new take on the Middle English Dictionary
- Host: GitHub
- URL: https://github.com/mlibrary/dromedary
- Owner: mlibrary
- Created: 2017-12-02T17:04:25.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T16:55:41.000Z (over 1 year ago)
- Last Synced: 2025-07-28T09:46:11.931Z (11 months ago)
- Language: Ruby
- Homepage:
- Size: 15.9 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dromedary -- Middle English Dictionary Application
A new(-ish, these days) discovery system for the Middle English Dictionary.
Confusingly, there are three separate repositories:
* [dromedary](https://github.com/mlibrary/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](https://github.com/mlibrary/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](https://github.com/mlibrary/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](docs/setting_up.md) 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](docs/indexing.md) talks about what the indexing
process does, where the important files are, and what code might be
interesting.
* [Configuration](docs/configuration.md) does a _very_ brief run through
the important ENV values. In general, the [compose.yml](compose.yml) file,
the argocd repository, and especially [lib/dromedary/services.rb](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](docs/solr.md) looks at the interesting bits of the
solr configuration, in particular the suggesters (for autocomplete).
* [Tour of the application code](docs/application_code.md) is a quick look at how
the MED differs from a stock Rails application.
### Access links
* **Public-facing application**: https://quod.lib.umich.edu/m/middle-english-dictionary/
* **"Preview" application with exposed Admin panel**: https://preview.med.lib.umich.edu/m/middle-english-dictionary/admin
### About upgrading
This repo currently runs on Ruby 2.x and Blacklight 5.x, and there are no plans
to upgrade either.
```shell
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.