{"id":18911045,"url":"https://github.com/ketan/paragliding-meshmap","last_synced_at":"2025-04-15T06:32:03.329Z","repository":{"id":246469405,"uuid":"821225810","full_name":"ketan/paragliding-meshmap","owner":"ketan","description":"Meshtastic map for paragliding pilots in India","archived":false,"fork":false,"pushed_at":"2024-11-04T10:05:55.000Z","size":9470,"stargazers_count":4,"open_issues_count":14,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-04T10:32:11.764Z","etag":null,"topics":["meshtastic","paragliding"],"latest_commit_sha":null,"homepage":"https://tracker.bircom.in","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/ketan.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-28T04:56:10.000Z","updated_at":"2024-11-04T10:05:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"ab0c33ad-0f31-4528-9922-f3d3f4f263e8","html_url":"https://github.com/ketan/paragliding-meshmap","commit_stats":null,"previous_names":["ketan/paragliding-meshmap"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ketan%2Fparagliding-meshmap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ketan%2Fparagliding-meshmap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ketan%2Fparagliding-meshmap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ketan%2Fparagliding-meshmap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ketan","download_url":"https://codeload.github.com/ketan/paragliding-meshmap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223664805,"owners_count":17182184,"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":["meshtastic","paragliding"],"created_at":"2024-11-08T09:47:38.704Z","updated_at":"2024-11-08T09:47:39.215Z","avatar_url":"https://github.com/ketan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# paragliding-meshmap\n\n# Deployment\n\n```bash\nyarn install\nyarn run docker:build\ndocker run -it -e DATABASE_URL=postgres://username:password@hostname:port/database-name paragliding-meshmap\n```\n\n# Development\n\nHere's how you set up a development environment for contributing to paragliding-meshmap. The first step\nis to run a postgres database. Keep this running in a terminal:\n\n```bash\ndocker run --env=POSTGRES_USER=postgres --env=POSTGRES_PASSWORD=postgres --env=POSTGRES_DB=meshmap -p 5432:5432 --volume=pgdata:/var/lib/postgresql/data -ti postgres:alpine\n```\n\nSet up an environment for your `yarn` commands:\n\n```bash\ncp .env.sample .env.development.local\n```\n\nUpdate the following line in `.env.development.local` to connect to the database server you\nstarted above.\n\n```\nDATABASE_URL=postgres://postgres:postgres@localhost:5432/meshmap\n```\n\nNow build the dependencies and run the backend and frontend together:\n\n```bash\nyarn install\nyarn run build\nyarn run start --mqtt-topics 'msh/#' --mqtt-broker-url=mqtt://mqtt.bircom.in --no-mqtt\n```\n\nConnect to http://localhost:5173 in your web browser, and the application should show up.\nIn order to get actual data showing up in the map, you'll need to request credentials to access\nthe MQTT (message queuing) server. Contact @ketan about this. Once and if you have them,\nrun the app like this:\n\n```\nyarn run start --mqtt-topics 'msh/#' --mqtt-broker-url=mqtt://mqtt.bircom.in --mqtt-username xxx --mqtt-password yyy\n```\n\nConnect again in your web browser. Be patient as the packets take time to trickle in from devices.\nWatch your console logs too, as various packets of node and position data come in, they'll show\nup as `INSERT` database statements.\n\n## Debugging/Troubleshooting\n\nYou can debug/troubleshoot things by setting the `DEBUG` variable using the `.env.development.local` file (or setting the `DEBUG` variable directly). Logging is enabled via the [`debug`](https://www.npmjs.com/package/debug) library, and you may checkout advanced usage in the debug library documentation.\n\nThe following values are supported for debugging\n\n| Value       | Usage                                                                                                                                                                                                                                                                                                               |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `typeorm:*` | Enables debugging of `typeorm` used for running DB queries. See [this file](\u003c[https://github.com/typeorm/typeorm/blob/master/src/logger/DebugLogger.ts](https://github.com/typeorm/typeorm/blob/e7649d2746f907ff36b1efb600402dedd5f5a499/src/logger/DebugLogger.ts#L13-L23)\u003e) for more fine grained logging options |\n| `meshmap:*` | Enable logging options for different features in this application. See [this file](https://github.com/ketan/paragliding-meshmap/blob/main/src/helpers/logger.ts) for more fine grained logging options                                                                                                              |\n| `mqtt:*`    | Enable logging options for the [mqttjs](https://github.com/mqttjs/MQTT.js) library.                                                                                                                                                                                                                                 |\n\n# Credits\n\n- [meshtastic](https://meshtastic.org) for building the great software that allows all of this to work.\n- [Liam Cottle](https://meshmap.app/) for the great work on the original map app, we are using the same codebase with\n  lots of modifications.\n\n# License\n\n```\nMIT License\n\nCopyright (c) 2024 Ketan Padegaonkar\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fketan%2Fparagliding-meshmap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fketan%2Fparagliding-meshmap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fketan%2Fparagliding-meshmap/lists"}