README.md

   1 # "The Rails Port"
   2
   3 [![Build Status](https://travis-ci.org/openstreetmap/openstreetmap-website.svg?branch=master)](https://travis-ci.org/openstreetmap/openstreetmap-website)
   4 [![Coverage Status](https://coveralls.io/repos/openstreetmap/openstreetmap-website/badge.svg?branch=master)](https://coveralls.io/r/openstreetmap/openstreetmap-website?branch=master)
   5
   6 This is The Rails Port, the [Ruby on Rails](http://rubyonrails.org/)
   7 application that powers the [OpenStreetMap](https://www.openstreetmap.org) website and API.
   8 The software is also known as "openstreetmap-website".
   9
  10 This repository consists of:
  11
  12 * The web site, including user accounts, diary entries, user-to-user messaging.
  13 * The XML-based editing [API](https://wiki.openstreetmap.org/wiki/API_v0.6).
  14 * The integrated versions of the [Potlatch](https://wiki.openstreetmap.org/wiki/Potlatch_1), [Potlatch 2](https://wiki.openstreetmap.org/wiki/Potlatch_2) and [iD](https://wiki.openstreetmap.org/wiki/ID) editors.
  15 * The Browse pages - a web front-end to the OpenStreetMap data.
  16 * The GPX uploads, browsing and API.
  17
  18 A fully-functional Rails Port installation depends on other services, including map tile
  19 servers and geocoding services, that are provided by other software. The default installation
  20 uses publicly-available services to help with development and testing.
  21
  22 # License
  23
  24 This software is licensed under the [GNU General Public License 2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt),
  25 a copy of which can be found in the [LICENSE](LICENSE) file.
  26
  27 # Installation
  28
  29 The Rails Port is a Ruby on Rails application that uses PostgreSQL as its database, and has a large
  30 number of dependencies for installation. For full details please see [INSTALL.md](INSTALL.md).
  31
  32 # Development
  33
  34 We're always keen to have more developers! Pull requests are very welcome.
  35
  36 * Bugs are recorded in the [issue tracker](https://github.com/openstreetmap/openstreetmap-website/issues).
  37 * Some bug reports are also found on the [OpenStreetMap trac](https://trac.openstreetmap.org/) system, in the "[website](https://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=website&order=priority)" and "[api](https://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=api&order=priority)" components.
  38 * Translation is managed by [Translatewiki](https://translatewiki.net/wiki/Translating:OpenStreetMap).
  39 * There is a [rails-dev@openstreetmap.org](https://lists.openstreetmap.org/listinfo/rails-dev) mailing list for development discussion.
  40 * IRC - there is the #osm-dev channel on irc.oftc.net.
  41
  42 More details on contributing to the code are in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
  43
  44 # Maintainers
  45
  46 * Tom Hughes [@tomhughes](https://github.com/tomhughes/)
  47 * Andy Allan [@gravitystorm](https://github.com/gravitystorm/)