Welcome to Open Plaques

Open Plaques is a service that aims to find and provide data about all the commemorative ‘plaques’ (often blue and round) that can be found across the UK and worldwide.

The website is written in Ruby on Rails (http://rubyonrails.org/), a web application framework which is written in the Ruby programming language (http://www.ruby-lang.org/en/).

Installation requirements

To run this website, you will need to have the following bits of software installed:

  • Ruby
  • Ruby on Rails
  • A database server – either MySQL or SQLite

Getting Started

To run the website, you will need to do the following first:

  1. Copy database.example.yml to database.yml in the config/ folder. If you’re using MySQL, you’ll need to edit the details to point at your MySQL database. Otherwise you can leave it as it is in order to use SQLite.
  2. Copy environment.example.rb to environment.rb in the config/ folder. You won’t need to edit anything to get started, though in order to use the Flickr import feature or geolocation features, you’ll have to register with the different services and copy in your API keys.
  3. From the command line, run rake gems:install (you may need to run it with sudo) to install a few required ruby gems.
  4. From the command line, run rake db:setup in order to set up your database and setup initial data.
  5. From the command line, run script/server in order to start the web server (Mongrel will be used by default). You should then be able to see the website at http://0.0.0.0:3000 (or whichever URL is specified at the command line).