How to set up openstreetmap-website for local development?

Follow the INSTALL.md guide which details installing PostgreSQL, Ruby on Rails, and numerous dependencies. It uses public services for testing, but full functionality requires additional setup.

Can I customize the OpenStreetMap website for my own use?

Yes, as an open-source Rails app, you can modify views and logic. However, deep customization requires Rails expertise and may involve community guidelines from CONTRIBUTING.md.

What's the difference between openstreetmap-website and Mapbox?

openstreetmap-website is focused on collaborative, open-data editing and the OSM community, while Mapbox is a commercial platform with pre-built mapping tools and paid support for visualization.

How do I contribute code to openstreetmap-website?

Check CONTRIBUTING.md, use the issue tracker for bugs, and participate in the rails-dev mailing list or IRC channel for development discussions, as mentioned in the README.

Is the OSM API stable for building third-party tools?

The API (v0.6) is established but can have changes; monitor project updates and community discussions on the mailing list to avoid breaking changes in integrations.

What are the rate limits for the OSM editing API?

Rate limits are not detailed in the README; you'll need to check the live OSM instance or community docs, as self-hosted setups may require custom configuration.

Open-Awesome

openstreetmap-website

GPL-2.0RubySelf-Hosted

The Ruby on Rails application that powers the OpenStreetMap website and its editing API.

Visit Website GitHub

2.8k stars1.1k forks0 contributors

What is openstreetmap-website?

openstreetmap-website is the Ruby on Rails application that powers the OpenStreetMap website and its API. It provides the user interface for browsing map data, managing accounts, and the programmatic interface for editing the collaborative map. It serves as the central hub for the OpenStreetMap project's web presence and data contribution workflow.

Target Audience

Developers contributing to or deploying instances of the OpenStreetMap platform, and those building tools that interact with its web API. It's also for open-source mapping enthusiasts and organizations running self-hosted mapping services.

Value Proposition

It is the official, open-source implementation of the OpenStreetMap web stack, enabling full control over the mapping platform. Developers choose it for its direct integration with the OSM ecosystem, extensible Rails architecture, and the ability to self-host a complete mapping website.

Overview

The Rails application that powers OpenStreetMap

Use Cases

Best For

Self-hosting an OpenStreetMap instance for internal or community use
Developing custom features or integrations for the OpenStreetMap website
Contributing to the core OpenStreetMap web application and API
Learning how a large-scale collaborative mapping platform is built
Running a localized or specialized version of OpenStreetMap
Building tools that interact programmatically with the OSM editing API

Not Ideal For

Projects needing a lightweight, single-page map viewer without backend complexity
Teams looking for a commercial mapping platform with out-of-the-box features and paid support
Applications focused solely on real-time map visualization without editing or community features

Pros & Cons

Pros

Official OSM Integration

Directly powers the OpenStreetMap website, ensuring full compatibility with OSM data standards and the collaborative mapping ecosystem, as it's the core application.

Modular Rails Architecture

Built on Ruby on Rails, making it extensible and maintainable for community contributions, with a focus on collaboration as noted in the README.

Comprehensive Editing API

Provides XML- and JSON-based API (v0.6) for programmatic map editing, supporting the entire data submission and modification workflow described in the features.

Community-Driven Ecosystem

Integrates with external services like Translatewiki for translations and osm-community-index for local chapters, fostering a vibrant open-source community.

Cons

Complex Setup Dependencies

The README admits a 'large number of dependencies' and reliance on external services like map tile servers, making installation and deployment non-trivial for new users.

Limited Out-of-the-Box Features

Requires external services for full functionality, such as geocoding and tile serving, which adds overhead and complexity compared to all-in-one solutions.

Potential Performance Overheads

As a monolithic Rails application handling map data, edits, and user accounts, it may require significant resources and optimization for scaling to high traffic.

Frequently Asked Questions

Related Projects

maybe

The personal finance app for everyone

Stars54,364

Forks5,644

Last commit1 year ago

mastodon

Your self-hosted, globally interconnected microblogging community

Stars50,139

Forks7,483

Last commit22 hours ago

discourse

A platform for community discussion. Free, open, simple.

Stars47,507

Forks8,953

Last commit20 hours ago

chatwoot

Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬

Stars34,698

Forks8,308