olm-architecture

Enforce OpenLitterMap v5 backend architecture rules for controllers, services, and Redis.

132|42|Updated Aug 19, 2020
One-click install
npx skills add https://github.com/OpenLitterMap/openlittermap-web --skill olm-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: olm-architecture
Source: https://github.com/OpenLitterMap/openlittermap-web/tree/main/.ai/skills/olm-architecture
Command: npx skills add https://github.com/OpenLitterMap/openlittermap-web --skill olm-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about olm-architecture

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I ensure backend metrics consistency when building a photo tagging pipeline?

Backend metrics consistency requires routing the Tag Pipeline strictly through MetricsService to enforce architectural rules, ensuring scalable data aggregation and preventing inconsistencies.

What is the safest approach for atomic approve operations in a backend architecture?

Atomic approve patterns in backend architecture enforce strict sequencing rules to prevent race conditions, ensuring safe, transactional data updates and fault tolerance across interactions.

How do I design backend services to handle map clustering and leaderboards safely?

Designing backend services for map clustering and leaderboards requires following canonical architectural guidelines that define safe clustering interactions and strict sequencing to maintain data integrity.

Why do I need exhaustive VerificationStatus enum usage in my backend architecture?

Exhaustive VerificationStatus enum usage is required in backend architecture to enforce strict state transitions, preventing invalid visibility states and ensuring data consistency throughout photo verification.

What are the limitations of integrating Redis directly without architectural guardrails?

Direct Redis integration without architectural guardrails risks race conditions and data inconsistencies, necessitating safe Redis interaction patterns to maintain fault tolerance and backend stability.