avo-hq/avo

Maplibre support

Open

#2,666 opened on Apr 7, 2024

View on GitHub
 (5 comments) (1 reaction) (0 assignees)Ruby (308 forks)user submission
FeatureHelp wanted

Repository metrics

Stars
 (1,778 stars)
PR merge metrics
 (Avg merge 1d 6h) (67 merged PRs in 30d)

Description

Feature

Add Maplibre support to Avo to have out of the box map support without requiring a dependency on an external commercial service.

Current workarounds

Sign up to Mapbox (free for 50k map loads/month).

Screenshots or screen recordings

Additional context

Maplibre "originated as an open-source fork of mapbox-gl-js, before their switch to a non-OSS license in December 2020." (ref)

Avo makes use of Mapkick to display a map; Mapkick JS supports Maplibre but Avo depends on the Ruby gem, which makes no reference to Maplibre. Because of this, a Mapbox API token is required to just test out Avo's map feature. By contrast, Maplibre does not require an API token for its demo map/style (it can also be downloaded). Avo could switch to Mapkick JS or add a direct dependency on Maplibre.

On a related note, it would be nice for the map feature to be included in the Avo demo.

Contributor guide

Research direction
Explore how Avo integrates the Mapkick gem and Mapkick JS, then implement support for Maplibre by either switching to Mapkick JS or adding a direct Maplibre dependency. Review the current Mapkick usage in the Avo codebase, particularly the map helper and views. Consider making the map provider configurable to support both Mapbox and Maplibre.
Tech stack
rubyjavascript
Domain
frontendbackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
RubyJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65