1714e2f02d
Remove the section of contributing docs about how `rake doc:app` can be used to generate some sort of documentation. That will not work any more, since this task was removed from Rails v5 because people don't generally use it! https://stackoverflow.com/a/36804474/338265 |
||
|---|---|---|
| .github | ||
| app | ||
| bin | ||
| config | ||
| db | ||
| docker | ||
| lib | ||
| public | ||
| script | ||
| storage | ||
| test | ||
| vendor/assets | ||
| .dockerignore | ||
| .editorconfig | ||
| .erb-lint.yml | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .rubocop.yml | ||
| .rubocop_todo.yml | ||
| config.ru | ||
| CONFIGURE.md | ||
| CONTRIBUTING.md | ||
| docker-compose.yml | ||
| DOCKER.md | ||
| Dockerfile | ||
| FAQ.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| INSTALL.md | ||
| LICENSE | ||
| package.json | ||
| Rakefile | ||
| README.md | ||
| VAGRANT.md | ||
| Vagrantfile | ||
| Vendorfile | ||
| yarn.lock | ||
"The Rails Port"
This is The Rails Port, the Ruby on Rails application that powers the OpenStreetMap website and API. The software is also known as "openstreetmap-website".
This repository consists of:
- The web site, including user accounts, diary entries, user-to-user messaging.
- The XML-based editing API.
- The integrated version of the iD editors.
- The Browse pages - a web front-end to the OpenStreetMap data.
- The GPX uploads, browsing and API.
A fully-functional Rails Port installation depends on other services, including map tile servers and geocoding services, that are provided by other software. The default installation uses publicly-available services to help with development and testing.
License
This software is licensed under the GNU General Public License 2.0, a copy of which can be found in the LICENSE file.
Installation
The Rails Port is a Ruby on Rails application that uses PostgreSQL as its database, and has a large number of dependencies for installation. For full details please see INSTALL.md.
Development
We're always keen to have more developers! Pull requests are very welcome.
- Bugs are recorded in the issue tracker.
- Translation is managed by Translatewiki.
- There is a rails-dev@openstreetmap.org mailing list for development discussion.
- IRC - there is the #osm-dev channel on irc.oftc.net.
More details on contributing to the code are in the CONTRIBUTING.md file.
Maintainers
- Tom Hughes @tomhughes
- Andy Allan @gravitystorm