omeka / omeka/plugin-Geolocation

Carto Basemaps Require API Key

Open Beginner friendly
#76 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
12
Forks
22
PR merge metrics
No merged PRs in 30d

Description

I think this kind of came out of nowhere, but Carto is now requiring an API key for all raster basemaps (and soon, vector tiles as well). See: carto.com/basemaps/apikey. So the config needs an option for storing the key, then the tile provider needs to include it, e.g. https://basemaps.cartocdn.com/rastertiles/voyager/{z}/{x}/{y}.png?key={apikey}.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the plugin configuration and the Carto raster tile provider referenced in the issue. Add a configuration option for the API key and verify that the generated raster tile URL includes it; done means the key can be stored and passed to the provider without breaking map display.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.