{"id":13878285,"url":"https://github.com/ankane/mapkick","last_synced_at":"2025-11-17T14:22:34.967Z","repository":{"id":65381522,"uuid":"591143171","full_name":"ankane/mapkick","owner":"ankane","description":"Create beautiful JavaScript maps with one line of Ruby","archived":false,"fork":false,"pushed_at":"2024-12-29T20:29:11.000Z","size":280,"stargazers_count":291,"open_issues_count":4,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-12T23:36:29.390Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://chartkick.com/mapkick","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ankane.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-20T02:24:17.000Z","updated_at":"2025-04-08T02:14:39.000Z","dependencies_parsed_at":"2023-12-26T20:42:07.704Z","dependency_job_id":"b9be5e3a-3dd7-4c0b-9092-fa5f5cd44e14","html_url":"https://github.com/ankane/mapkick","commit_stats":{"total_commits":38,"total_committers":1,"mean_commits":38.0,"dds":0.0,"last_synced_commit":"171d3ed9b3c83ce4ecfa8c8f7620bc08a22acccb"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fmapkick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fmapkick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fmapkick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fmapkick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ankane","download_url":"https://codeload.github.com/ankane/mapkick/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647257,"owners_count":21139081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T08:01:45.196Z","updated_at":"2025-11-17T14:22:34.890Z","avatar_url":"https://github.com/ankane.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Mapkick\n\nCreate beautiful JavaScript maps with one line of Ruby. No more fighting with mapping libraries!\n\n[See it in action](https://chartkick.com/mapkick)\n\n:fire: For static maps, check out [Mapkick Static](https://github.com/ankane/mapkick-static), and for charts, check out [Chartkick](https://chartkick.com)\n\n[![Build Status](https://github.com/ankane/mapkick/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/mapkick/actions)\n\n## Installation\n\nAdd this line to your application’s Gemfile:\n\n```ruby\ngem \"mapkick-rb\"\n```\n\nMapkick uses [Mapbox GL JS v1](https://github.com/mapbox/mapbox-gl-js/tree/v1.13.3). To use tiles from Mapbox, [create a Mapbox account](https://account.mapbox.com/auth/signup/) to get an access token and set `ENV[\"MAPBOX_ACCESS_TOKEN\"]` in your environment (or set `Mapkick.options[:access_token]` in an initializer).\n\nThen follow the instructions for your JavaScript setup:\n\n- [Importmap](#importmap) (Rails 7+ default)\n- [Bun, esbuild, rollup.js, or Webpack](#bun-esbuild-rollupjs-or-webpack)\n- [Sprockets](#sprockets)\n\n### Importmap\n\nIn `config/importmap.rb`, add:\n\n```ruby\npin \"mapkick/bundle\", to: \"mapkick.bundle.js\"\n```\n\nAnd in `app/javascript/application.js`, add:\n\n```js\nimport \"mapkick/bundle\"\n```\n\n### Bun, esbuild, rollup.js, or Webpack\n\nRun:\n\n```sh\nbun add mapkick\n# or\nyarn add mapkick\n```\n\nAnd in `app/javascript/application.js`, add:\n\n```js\nimport \"mapkick/bundle\"\n```\n\n### Sprockets\n\nIn `app/assets/javascripts/application.js`, add:\n\n```js\n//= require mapkick.bundle\n```\n\n## Maps\n\nPoint map\n\n```erb\n\u003c%= js_map [{latitude: 37.7829, longitude: -122.4190}] %\u003e\n```\n\nArea map\n\n```erb\n\u003c%= area_map [{geometry: {type: \"Polygon\", coordinates: ...}}] %\u003e\n```\n\n## Data\n\nData can be an array\n\n```erb\n\u003c%= js_map [{latitude: 37.7829, longitude: -122.4190}] %\u003e\n```\n\nOr a URL that returns JSON (same format as above)\n\n```erb\n\u003c%= js_map cities_path %\u003e\n```\n\n### Point Map\n\nUse `latitude` or `lat` for latitude and `longitude`, `lon`, or `lng` for longitude\n\nYou can specify a label, tooltip, and color for each data point\n\n```ruby\n{\n  latitude: ...,\n  longitude: ...,\n  label: \"Hot Chicken Takeover\",\n  tooltip: \"5 stars\",\n  color: \"#f84d4d\"\n}\n```\n\n### Area Map\n\nUse `geometry` with a GeoJSON `Polygon` or `MultiPolygon`\n\nYou can specify a label, tooltip, and color for each data point\n\n```ruby\n{\n  geometry: {type: \"Polygon\", coordinates: ...},\n  label: \"Hot Chicken Takeover\",\n  tooltip: \"5 stars\",\n  color: \"#0090ff\"\n}\n```\n\n## Options\n\nId, width, and height\n\n```erb\n\u003c%= js_map data, id: \"cities-map\", width: \"800px\", height: \"500px\" %\u003e\n```\n\nMarker color\n\n```erb\n\u003c%= js_map data, markers: {color: \"#f84d4d\"} %\u003e\n```\n\nShow tooltips on click instead of hover\n\n```erb\n\u003c%= js_map data, tooltips: {hover: false} %\u003e\n```\n\nAllow HTML in tooltips (must sanitize manually)\n\n```erb\n\u003c%= js_map data, tooltips: {html: true} %\u003e\n```\n\nMap style\n\n```erb\n\u003c%= js_map data, style: \"mapbox://styles/mapbox/outdoors-v12\" %\u003e\n```\n\nZoom and controls\n\n```erb\n\u003c%= js_map data, zoom: 15, controls: true %\u003e\n```\n\nRefresh data from a remote source every `n` seconds\n\n```erb\n\u003c%= js_map url, refresh: 60 %\u003e\n```\n\nPass options directly to the mapping library\n\n```erb\n\u003c%= js_map data, library: {hash: true} %\u003e\n```\n\nSee the documentation for [Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js/api/map/) for more info\n\n### Global Options\n\nTo set options for all of your maps, create an initializer `config/initializers/mapkick.rb` with:\n\n```ruby\nMapkick.options[:height] = \"400px\"\n```\n\n## Sinatra and Padrino\n\nDownload [mapkick.bundle.js](https://raw.githubusercontent.com/ankane/mapkick/master/vendor/assets/javascripts/mapkick.bundle.js) and include it manually.\n\n```html\n\u003cscript src=\"mapkick.bundle.js\"\u003e\u003c/script\u003e\n```\n\n## History\n\nView the [changelog](CHANGELOG.md)\n\n## Contributing\n\nEveryone is encouraged to help improve this project. Here are a few ways you can help:\n\n- [Report bugs](https://github.com/ankane/mapkick/issues)\n- Fix bugs and [submit pull requests](https://github.com/ankane/mapkick/pulls)\n- Write, clarify, or fix documentation\n- Suggest or add new features\n\nTo get started with development:\n\n```sh\ngit clone https://github.com/ankane/mapkick.git\ncd mapkick\nbundle install\nbundle exec rake test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankane%2Fmapkick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankane%2Fmapkick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankane%2Fmapkick/lists"}