README.md

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