BPLDC Authority API
A lightweight API-only Rails app that provides authority data and controlled values for descriptive metadata records conforming to the BPLDC MODS Application Profile.
See the wiki for more information:
- Authorities List: Retrieve a list of supported authorities/vocabularies
- Geomash API: Retrieve structured geographic information from TGN, GeoNames, and Google Maps API Geocoder
- Controlled values: Returns all possible values for controlled fields: basic genre, language, license, resource type, and role
- Querying authorities
- Get label for vocabulary id: Use a vocabulary id to fetch the label for a term
- Search for terms: Search for terms from an authority by keyword/string; returns a list of matches
Running with Docker
Run the following commands from the project root:
- Start Ruby/Rails and Postgres containers:
$ docker-compose up
Note entrypoint.sh runs `bundle exec rails db:prepare` which creates the databases and runs the migrations
2. From another terminal window, run:$ docker-compose run app rails db:seed
3. To rebuild the container run$ docker-compose build --no-cache
The application will be available on `localhost:3001`. Use `docker-compose up -d` and `docker-compose down` to start/stop the application.