{"id":13554161,"url":"https://github.com/osmlab/learnoverpass","last_synced_at":"2025-09-15T09:17:14.676Z","repository":{"id":33109547,"uuid":"36747409","full_name":"osmlab/learnoverpass","owner":"osmlab","description":"LearnOverpass is the definitive, one stop learning resource for the Overpass API.","archived":false,"fork":false,"pushed_at":"2023-03-17T23:30:50.000Z","size":1601,"stargazers_count":71,"open_issues_count":28,"forks_count":23,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-11-04T02:32:47.323Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://osmlab.github.io/learnoverpass/en/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osmlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-06-02T16:48:36.000Z","updated_at":"2024-10-17T21:05:59.000Z","dependencies_parsed_at":"2024-01-19T17:58:10.525Z","dependency_job_id":"3ec902af-ba5b-479b-bf1c-02a4af28791f","html_url":"https://github.com/osmlab/learnoverpass","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmlab%2Flearnoverpass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmlab%2Flearnoverpass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmlab%2Flearnoverpass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmlab%2Flearnoverpass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osmlab","download_url":"https://codeload.github.com/osmlab/learnoverpass/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246947947,"owners_count":20859346,"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-01T12:02:40.871Z","updated_at":"2025-04-03T06:31:12.501Z","avatar_url":"https://github.com/osmlab.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"# LearnOverpass\n\nThis project aims to create a complete, one stop, learning resource for the overpass API.\n\nIt features a beginner-friendly, easy-to navigate documentation, as well as an interactive suite of tutorials to teach different aspects of the API.\n\n## Contribution Guide\n\nWe accept contributions/edits to the site! Feel free to do a pull request if you see an error in the docs/outdated material.\n\nTranslation to various languages is also an aspect we need contribution towards to.\n\nA detailed contribution guide can be seen [here](CONTRIB.md)\n\n## Development Guide\n\nThe project is/will be built using (mainly) the following dependencies/frameworks:\n\n- [Hugo](http://gohugo.io) - static site generator written in Go\n- [Gulp](http://gulpjs.com) - task manager for preprocessing/asset pipeline\n- [ReactFlux](https://www.npmjs.com/package/react-flux) - main framework for the tutorial engine\n- Ace Editor/Code Mirror - for the online code editor\n- [Stylus](https://learnboost.github.io/stylus/) - CSS meta language\n\n### Setup\n\n#### TL;DR\n\n1. Install [NodeJS](https://nodejs.org/en/), [npm](https://www.npmjs.com/)\n2. Install gulp: `npm install -g gulp`\n3. Run `npm install`\n4. Run `gulp`\n5. Open http://localhost:1313/\n\n#### Detailed Setup Instructions\n\nIf this is the first time you're working with the node ecosystem, install [node](https://nodejs.org) first. This will add a binary named `npm` in your path.\n\nThen, run `npm install` on the root directory of this project, as well as `npm install -g gulp`.\n\nThe theme/layout code can be found under the `themes/src` directory. Gulp is a task manager that compiles these files to `themes/overpass_doc` which is the flat html/css files used by the site.\n\n`gulp build` needs to be run to compile the src theme. The default `gulp` task, apart from building the layout and running hugo, includes a file watcher that automatically detects changes in the src and compiles it for you, you which is ideal if you are developing the theme/layout.\n\n__Note on i18n:__\nHugo does not natively support i18n/localization, and certain things have been worked around with to make it work. The site uses content sections to order the content by language (en/data, de/data etc.), and uses taxonomies to categorize the different content.\n\n### Deploy Script\n\nThe project is deployed through the github pages service. The flat hugo files are pushed to the gh-pages branch.\n\nA `deploy.sh` script is included in the repo to push changes to gh-pages automatically.\n\n## License\n\nThe website's source is released under the MIT License.\n\nThe documentation and courses is released under GNU FDL.\n\n## Special Thanks to:\n\nThis project is made possible through Google's Summer of Code (GSOC) 2015 Program.\n\nThe mentor for this project is none other than Martin Raifer (@tyr_asd), responsible for the excellent [Overpass Turbo](http://overpass-turbo.eu).\n\nWeekly writeups on the project were posted on Arian's [blog](http://arianv.com/series/gsoc-2015/). Arian (@secretmapper) is the GSOC student for this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosmlab%2Flearnoverpass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosmlab%2Flearnoverpass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosmlab%2Flearnoverpass/lists"}