{"id":20571862,"url":"https://github.com/sigfox/sigfox-maps","last_synced_at":"2025-10-30T06:42:34.825Z","repository":{"id":47556486,"uuid":"156576016","full_name":"sigfox/sigfox-maps","owner":"sigfox","description":"Display public sigfox service map","archived":false,"fork":false,"pushed_at":"2022-12-10T16:33:36.000Z","size":907,"stargazers_count":4,"open_issues_count":2,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-14T17:07:32.488Z","etag":null,"topics":["javascript","leaflet","maps","nodejs","sigfox","sigfox-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/sigfox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-07T16:29:08.000Z","updated_at":"2022-12-08T08:17:35.000Z","dependencies_parsed_at":"2023-01-26T09:31:31.090Z","dependency_job_id":null,"html_url":"https://github.com/sigfox/sigfox-maps","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sigfox%2Fsigfox-maps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sigfox%2Fsigfox-maps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sigfox%2Fsigfox-maps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sigfox%2Fsigfox-maps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sigfox","download_url":"https://codeload.github.com/sigfox/sigfox-maps/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248923765,"owners_count":21183953,"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":["javascript","leaflet","maps","nodejs","sigfox","sigfox-api"],"created_at":"2024-11-16T05:17:34.351Z","updated_at":"2025-10-30T06:42:34.739Z","avatar_url":"https://github.com/sigfox.png","language":"JavaScript","readme":"# Sigfox-maps\n\nThis project is an example of how to use the Sigfox backend API to display your own maps. \n\nThere are 2 layers demonstrated in this project:\n- `Public map`\n- `Monarch coverage map`\n\n## Technologies\n\nThis application is a simple [nodeJs](http://nodejs.org) server application which uses [Express](http://expressjs.com) \nfor routing and [Pug](https://pugjs.org) for templating. \nThe simple frontend uses [Leaflet](https://leafletjs.com/) to display maps.\n\n## Prerequisites\n\nTo run/use this sample project, you will need git and nodejs (at least v8.10.0) installed.\n\nIf you really do not want to install git, just hit the download button, to retrieve a tarball of the whole repository. \n\n## Configuration\n\nTo configure properly the application, you need to rename the config.js.sample to config.js and edit this file to provide your own setup.\n\n```javascript\nconst config = {\n    sigfoxApiUser: \"yourSigfoxApiUser\",\n    sigfoxApiPassword: \"yourSigfoxApiPassword\",\n    sigfoxApiSite: \"api.sigfox.com\",\n    publicMapPath: \"/v2/tiles/public-coverage\",\n    monarchMapPath: \"/v2/tiles/monarch\",\n    https: true,\n    \n    //---- For MapBox background map\n    backgroundMapType: \"Basic\",\n    backgroundMap: \"https://api.mapbox.com/v4/mapbox.light/{z}/{x}/{y}.png?access_token={yourToken}\"\n}\n```\n\nIn production situation, you should only set your own credentials to access the Sigfox API and set your background map URL according to your map provider.\n\nThe example above showcases a [Mapbox](https://www.mapbox.com/) map with a light style (you'll have to set your own token). To sum up, the `backgroundMap` property expects a TMS URL.\nYou can use other background map providers by switching properties ([Jawg](https://www.jawg.io), [Here](https://developer.here.com/), [Google](https://cloud.google.com/maps-platform) or [Bing](https://www.bingmapsportal.com)).\n\nIn test situation, you might want to mock the Sigfox Backend. In order to do this, you can edit the other properties :\n\n- `sigfoxApiSite` to specify the base URL of your mock (including the http(s) prefix)\n- `publicMapPath` to specify the endpoint. To provide a compatible endpoint, check the documentation of the Sigfox API v2\n- `monarchMapPath` to specify the endpoint. To provide a compatible endpoint, check the documentation of the Sigfox API v2\n- `https` to specify if your mock is deployed on https context (set it to true), or http (set it to false)\n\n## How to run\n\nYou just have to do a simple : `npm install \u0026\u0026 npm start`\nOn Windows the `\u0026\u0026` operator might not work, so, launch in sequence\n```\nnpm install\nnpm start\n```\n\nOpen the url \u003chttp://localhost:3000/\u003e on your browser.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsigfox%2Fsigfox-maps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsigfox%2Fsigfox-maps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsigfox%2Fsigfox-maps/lists"}