olm-architecture

Official

Master OpenLitterMap v5 architecture end-to-end.

AuthorOpenLitterMap
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Provides a canonical reference for OpenLitterMap v5 architecture to ensure consistent, scalable backend development and to help developers avoid architectural mistakes.

Core Features & Use Cases

  • Establishes consistent architectural guidelines for key components (MetricsService, Tag pipeline, VerificationStatus enum, and Redis integration) and provides a reference for implementing controllers, services, events, and clustering.
  • Use Cases include building backend features for photo tagging, visibility, school pipelines, leaderboards, and map clustering while ensuring data integrity and fault tolerance.
  • The architecture defines safe, atomic patterns (e.g., Atomic Approve) and strict sequencing rules to prevent race conditions and data inconsistencies.

Quick Start

Review this architecture reference before coding backend features to ensure alignment with OpenLitterMap v5 patterns.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: olm-architecture
Download link: https://github.com/OpenLitterMap/openlittermap-web/archive/main.zip#olm-architecture

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.