Skip to content
This repository
branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 app the bestest fastest maps so far!
Octocat-spinner-32 config better tile data routing
Octocat-spinner-32 db store a series reference (if it exists). Can be a string
Octocat-spinner-32 doc Updating gitignore so that docs are ignored. Adding required READMEs
Octocat-spinner-32 lib Making it easy to generate some local plaques
Octocat-spinner-32 public calm the crawlers a bit
Octocat-spinner-32 script Initial import of repo from https://openplaques.googlecode.com/svn/br…
Octocat-spinner-32 test Fixing a bunch of functional tests (we rescue from ActiveRecord::Reco…
Octocat-spinner-32 vendor move out of vendor directory
Octocat-spinner-32 .gitignore Switchint to Unicorn as server-layer
Octocat-spinner-32 .slugignore Don't ignore doc
Octocat-spinner-32 .travis.yml Testing
Octocat-spinner-32 Gemfile Adding a way to create a first admin user
Octocat-spinner-32 Gemfile.lock Adding rails12factor gem to avoid some Heroku warnings
Octocat-spinner-32 Procfile Switchint to Unicorn as server-layer
Octocat-spinner-32 README minor
Octocat-spinner-32 README.md Updated instructions in README
Octocat-spinner-32 Rakefile Initial import of repo from https://openplaques.googlecode.com/svn/br…
Octocat-spinner-32 config.ru Initial import of repo from https://openplaques.googlecode.com/svn/br…
Octocat-spinner-32 example.env Specify secret keys on an environment basis
Octocat-spinner-32 install_curb_on_Windows.bat if you are on Windows
Octocat-spinner-32 start.bat it is 'rails server' nowadays
README.md

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, 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, version 2.0.0
  • Bundler
  • A database server - either PostGres (preferred) or SQLite

Further dependencies are managed using Bundler, which will install them for you. These include things like Rails and a JSON library.

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 PostGres, you can leave it as it is – just make sure that you’ve created a local database called openplaques which doesn't require a username or password. You should also create a second database called openplaques_test in order to run the tests. If for some reason you can’t use PostGres, you can edit the file to specify a MySQL or SQLite3 connection.
  2. From the command line, run bundle install to install a few required ruby gems.
  3. From the command line, run bundle exec rake db:setup in order to set up your database and setup initial data.
  4. Copy the config file example.env to .env (on a command line this can be done with cp example.env .env).
  5. From the command line, run foreman start in order to start the web server. 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).

Making Contributions

We really welcome contributions to this project, whether they are simple bug fixes, user interface improvements, or new ways for people to access the data.

The simplest way to contribute is to fork this project on GitHub, make your changes, and then submit a Pull Request.

If you have an idea for a major new feature, or for some changes to the actual database, it may be best to discuss the idea with the community first. You can do so by creating an Issue for your suggested change.

Something went wrong with that request. Please try again.