Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 1.97 KB

README.md

File metadata and controls

73 lines (51 loc) · 1.97 KB

Compass

Build Status Docker Image Docker Version

Lewis and Clark's Geoblacklight instance, hosted at geo.watzek.cloud.

Development

Prerequisites

  1. PostgreSQL.
  • Make sure it is configured in a way that it uses your current system's credential. More information can be found here.

  1. Ruby >= 2.2.5

  2. RabbitMQ

Installing

  1. Clone the repository:
git clone https://github.com/watzek/compass.git
  1. Inside compass directory install the gems:
bundle install
  1. Create and migrate database:
rake db:create
rake db:migrate
  1. Test it:
rake test
  1. To run the application:
rake geoblacklight:server

Contributing

  1. Make sure you fork the repository

  2. Create github issue before submitting a PR

  3. Write spec or integration tests using rspec or capybara

  4. Make sure your commit message reads:

(#Issue No.) Commit message describing the change made by this patch

Example commit message:

(#23) Enable fullscreen leaflet

If your PR does not bring in a big change in functionality like updating documentation, etc. you can file a "maint" PR.

Example commit message for maint PR:

(MAINT) Update README.md

Your PR will be reviewed by the maintainers once it passes all the tests through our CI.