diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..f2de0b83e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,13 @@ +### Description + + + + + +### Checklist + +- [ ] checked dark mode / light mode +- [ ] checked mobile / desktop +- [ ] checked server-side-rendering (SSR) +- [ ] code style is consistent with the rest of the project +- [ ] new dependencies are reasoned about in PR comments diff --git a/.github/vercel.svg b/.github/vercel.svg new file mode 100644 index 000000000..877828684 --- /dev/null +++ b/.github/vercel.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/README.md b/README.md index f7688fdb6..208de2163 100644 --- a/README.md +++ b/README.md @@ -29,19 +29,23 @@ You may [add issues](https://github.com/zbycz/osmapp/issues) here on GitHub, or > If you are a JS dev, you may also `git clone` / `yarn` / `yarn dev` \ > Or [open OsmAPP in gitpod](https://gitpod.io/#https://github.com/zbycz/osmapp) or GitHub Codespaces – full dev environment in your browser. \ > If Vercel build fails, please run `yarn build` locally to debug it. \ -> Some architecture [DOCS here](./DOCS.md). +> [Architecture DOCS here](./DOCS.md). ## Features πŸ—Ί πŸ“± πŸ–₯ - **clickable map** – poi, cities, localities, ponds (more coming soon) -- **info panel** – presets and fields from iD, images from Wikipedia, Mapillary or Fody, line numbers on public transport stops -- **editing** – with osm login. For anonymous users a note is inserted. +- **feature panel** – presets and fields from iD editor + - Display multiple images from Wikipedia, Wikidata, Commons, Mapillary or Fody + - Line numbers on public transport stops + - Runway table on airports +- **editing** – Save changes with osm login. Insert note for anonymous users. + - Opening hours editor – use simple editor for most common cases. - **search engine** – try for example "Tesco, London" (powered by Photon). - Category search from [iD editor presets](https://github.com/openstreetmap/id-tagging-schema) - or pure overpass search (eg. `amenity=*` or `op:`) + - Category search from [iD editor presets](https://github.com/openstreetmap/id-tagging-schema) + - For advanced users: support for overpass queries (eg. `amenity=*` or `op:`) - **vector maps** – with the possibility of tilting to 3D (drag the compass, or do two fingers drag) -- **3D terrain** – turned on when tilted (use terrain icon to toggle off) -- **tourist map** – from MapTiler: vector, including marked routes + - 3D terrain – turned on when tilted + - tourist map – vector Outoodr map from MapTiler including marked routes - **layer switcher** – still basic, but you can add your own layers - **mobile applications** – using PWA technology, see [osmapp.org/install](https://osmapp.org/install) - **permanent URLs** – eg. [osmapp.org/way/123557148](https://osmapp.org/way/123557148) and shortener, eg. [osmapp.org/kkjwwaw](https://osmapp.org/kkjwwaw) @@ -50,77 +54,37 @@ You may [add issues](https://github.com/zbycz/osmapp/issues) here on GitHub, or - **undelete** – undo accidental delete in osmapp or elsewhere, eg. [here](https://osmapp.org/node/1219767385) - and lot of little details πŸ™‚ -### Coming soon +### Change log + Roadmap (coming soon) -- add routing [#31](https://github.com/zbycz/osmapp/issues/31) -- some ideas in [wireframes](https://drive.google.com/drive/folders/0B7awz2fKhg6yQ0JqTjhJRFV5aEE?resourcekey=0-NwX0M0KC3u85IGGyFonJAA&usp=sharing) +- ➑️ [Changelog here](https://github.com/zbycz/osmapp/releases) +- ➑️ [Roadmap here](https://github.com/zbycz/osmapp/issues/507) -### Compatibility +_OsmAPP is updated continuously with every commit. Versioning is used only for summarizing the changes once in a while._ -- tested in Chrome 90 (Mac,Win,Android,iOS), Safari 14, Firefox 88, Edge 90 (slow) -- [webgl](https://caniuse.com/webgl) technology needed +You may discuss OsmAPP in [Openstreetmap Discord, channel #software](https://discord.com/channels/413070382636072960/429092644438802432) – tag @zbycz. -### Changelog +## Special thanks to -OsmAPP is updated continuously with every commit. Versioning is used only for summarizing the changes once in a while: +We are standing on the shoulders of giants, OsmAPP would not be possible without: +[OpenStreetMap](https://www.openstreetmap.org/), +[MapLibre GL](https://maplibre.org/maplibre-gl-js/), +[Wikimedia projects](https://www.wikimedia.org/), +[Photon search](https://photon.komoot.io/), +[Mapillary](https://www.mapillary.com/), +[Overpass](https://wiki.openstreetmap.org/wiki/Overpass_API), +[iD editor tagging schema](https://github.com/openstreetmap/id-tagging-schema), +[React](https://react.dev/), +[Next.js](https://nextjs.org/), +[Material-UI](https://mui.com/), +and many, many others. -- **v1.4.0** (6/2024) +Also, big thanks for Free licenses from these awesome companies: - - FeaturePanel - - - πŸŽ‰ use iD Tagging scheme for properties ([PR1](https://github.com/zbycz/osmapp/pull/131), [2](https://github.com/zbycz/osmapp/pull/197)) - - πŸ–Ό add panellum Panorama viewer for Mapillary (@Dlurak, [PR](https://github.com/zbycz/osmapp/pull/234)) - - ⭐️ add Stars (favorites) to every element ([PR](https://github.com/zbycz/osmapp/pull/229)) - - 🚌 add public transport labels (@Dlurak, [PR1](https://github.com/zbycz/osmapp/pull/175), [2](https://github.com/zbycz/osmapp/pull/187)) - - add Food hygiene rating scheme (@Dlurak, [PR](https://github.com/zbycz/osmapp/pull/179)) - - add geoUri to coordinates dropdown on mobile ([PR](https://github.com/zbycz/osmapp/pull/153)) - - - Search - - - πŸ”Ž add search by categories + by overpass query ([PR1](https://github.com/zbycz/osmapp/pull/186), [2](https://github.com/zbycz/osmapp/pull/192), [3](https://github.com/zbycz/osmapp/pull/213)) - - - Layers: - - - πŸ”οΈ add 3D terrain when user tilts ([PR1](https://github.com/zbycz/osmapp/pull/184), [2](https://github.com/zbycz/osmapp/pull/193)) - - ❄️ add overlays support + Snow overlay ([PR](https://github.com/zbycz/osmapp/pull/244)) - - 🏞️ add cliffs to outdoor style ([PR](https://github.com/zbycz/osmapp/pull/264)) - - add attribution to layers ([PR](https://github.com/zbycz/osmapp/pull/154)) - - use new maptiler satellite (@kudlav, [PR](https://github.com/zbycz/osmapp/pull/151)) - - add bing satellite ([PR](https://github.com/zbycz/osmapp/pull/155)) - - add OpenPlaceGuide Africa - makina maps in Africa bbox ([PR](https://github.com/zbycz/osmapp/pull/205)) - - add ČÚZK Ortophoto in CZ bbox ([PR](https://github.com/zbycz/osmapp/pull/245)) - - - misc - - - πŸ•ΈοΈ add url shortener for every feature ([PR](https://github.com/zbycz/osmapp/pull/290)) - - hackish fix of corrupted id from Maptiler ([PR](https://github.com/zbycz/osmapp/pull/230)) - - use OAuth 2.0, login button ([PR](https://github.com/zbycz/osmapp/pull/235), [2](https://github.com/zbycz/osmapp/pull/316), [3](https://github.com/zbycz/osmapp/pull/355)) - - add disclaimer to homepage – not an official app ([PR](https://github.com/zbycz/osmapp/pull/233)) - - optimize homepage because of [hackernews mention](https://news.ycombinator.com/item?id=38795559) πŸ₯° ([PR](https://github.com/zbycz/osmapp/pull/219)) - - support language prefixes for all URLs for SEO ([PR](https://github.com/zbycz/osmapp/pull/141)) - - - climbing features - - πŸ§— topo viewer and editor (@jvaclavik, many PRs) - - πŸ—ΊοΈ add climbing overlay ([PR1](https://github.com/zbycz/osmapp/pull/295), [2](https://github.com/zbycz/osmapp/pull/294), [3](https://github.com/zbycz/osmapp/pull/293), [4](https://github.com/zbycz/osmapp/pull/292), [5](https://github.com/zbycz/osmapp/pull/344)) - - add branding for openclimbing.org domain ([PR](https://github.com/zbycz/osmapp/pull/263)) - -- **v1.3.0** (3/2023) - - - πŸ’‘ added dark mode UI ([PR](https://github.com/zbycz/osmapp/pull/137)) - - πŸ–Ό updated to Mapillary v4 (@kudlav, [PR](https://github.com/zbycz/osmapp/pull/113)) - - added Spanish (@kresp0, [PR](https://github.com/zbycz/osmapp/pull/115)) - - added Italian (@ricloy, [PR](https://github.com/zbycz/osmapp/pull/108)) - - added French (@le-jun, [PR](https://github.com/zbycz/osmapp/pull/101)) - -- **v1.2.0** (2/2022) - - - πŸ”Ž changed search to Photon API (@kudlav, [PR](https://github.com/zbycz/osmapp/pull/84)) - - added Amharic (@amenk, [PR](https://github.com/zbycz/osmapp/pull/89)) - - added German (@amenk, [PR](https://github.com/zbycz/osmapp/pull/88)) - - added Polish (@strebski, [PR](https://github.com/zbycz/osmapp/pull/77)) - -- **v1.1.0** (8/2021) - - changed search to Maptiler API (@charleneolsen, [PR](https://github.com/zbycz/osmapp/pull/57)) +- [MapTiler](https://www.maptiler.com/) – vector tiles +- [InteliJ IDEA](https://www.jetbrains.com/idea/) – Webstorm IDE +- [Sentry](https://sentry.io/) – error tracking +- [Vercel](https://vercel.com/) – hosting with generous free-tier \ + [![vercel.svg](.github/vercel.svg)](https://vercel.com/?utm_source=osm-app-team&utm_campaign=oss) ## License @@ -128,19 +92,13 @@ GNU GPL ## Related projects -We may reuse it in osmapp in the future. First two via [#217](https://github.com/zbycz/osmapp/issues/217) – thanks to @leam. - +- **Cartes.app** πŸ‡«πŸ‡· + - Universal osm app by [@leam](https://github.com/laem) via [#217](https://github.com/zbycz/osmapp/issues/217) + - https://cartes.app ([GitHub](https://github.com/laem/cartes)) +- **OpenStreetMap-NG** + - Migration of OSM.org to new technologies. We support this project! 🀞❀️ + - [https://github.com/Zaczero/openstreetmap-ng](https://github.com/Zaczero/openstreetmap-ng/blob/main/ANNOUNCEMENT.md) - **Qwant Maps** (sadly not developed anymore) - - - great tech stack: [BE in Python](https://github.com/Qwant/idunn), geocoding, directions, MaplibreGL + - great tech stack: [BE in Python](https://github.com/Qwant/idunn), geocoding, directions, MaplibreGL. We may reuse parts of code in future. - https://github.com/Qwant/qwantmaps - - eg. https://qwant.com/maps/place/osm:node:1369322781 – super fast - -- **Future.eco Voyage** - - - Universal osm app by [@leam](https://github.com/laem) - - https://futur.eco/voyage ([GitHub](https://github.com/laem/futureco/tree/master/app/voyage)) - -- **OpenStreetMap-NG** - - We support this project! 🀞 - - https://github.com/Zaczero/openstreetmap-ng/blob/main/ANNOUNCEMENT.md + - Url was eg. `https://qwant.com/maps/place/osm:node:1369322781` – super fast + SSR