Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 3.26 KB

Development.md

File metadata and controls

47 lines (28 loc) · 3.26 KB
Raw

radlkarte.at - Development

Development guidelines for the website.

Local environment

To use work on the radlkarte.at locally, either to develop the codebase or make using the scripts easier, you need to install Node.js and Yarn >= 4 on your computer. If you just want to run the radlkarte.at locally in your browser to, i.e. to preview your changes made in JOSM before committing them, you can do so by running the following command (you still need Node.js for it):

npx http-server -a localhost -s

Then you can open it in the browser using http://localhost:8080.

Setup

First install Node.js 18.x or newer (please only use versions with an even major version number: 18.x, 20.x, …). Then install Yarn by enabling Corepack: corepack enable.

Now you have prepared your computer (you might whish to install an IDE like VSCode or Webstorm or a git client as well) and can setup the repository. Create a personal fork from markusstraub/radlkarte, clone it and execute yarn install in its root folder. This will install all dependencies in your project (as of Feb. 2024 only the development tools).

Available tools and scripts

There are a some scripts helping with the data (preparing the GeoJSON files – minifying, add bbox, ensure all objects have a unique ID etc. – downloading POI data from OSM via Overpass queries) and more technical tools like linting the HTML and JavaScript code or running a local HTTP hosting the radlkarte.at locally.

All of them are made available via Yarn scripts and you simply can execute yarn start to show a list of all available scripts with explanation.

Note

Because commands like yarn help, yarn info, yarn why (that's the name of the package generating the script help displayed) are special Yarn commands, we cannot use those names for the help script, and as yarn start usually is the script to start a project, this is used to show our help instead of starting the local HTTP server.

Starting the HTTP server

To start the HTTP server run yarn serve. Then you can open the radlkarte on http://localhost:8081, caching is disabled.

Downloading POI data

To download the POI data from OSM you can either use yarn pois to download all data (which can take a while) or yarn pois:[region] to download it only for a specific region, i.e. yarn pois:wien for Vienna.

You can append the parameter --only-query with one of the following values to only download data for the given type of POIs:

  • subway => Subway stations (Vienna only)
  • subwayLines => Subway lines (Vienna only)
  • railway => Railway stations
  • railwayLines = Railway lines with bicycle transport permission without reservation ("S-Bahn")
  • bicycleShop => Bicycle shops and general sport shops with bicycle retail or repair services
  • bicycleRepairStation => Bicycle self-repair stations
  • bicyclePump => Bicycle self-service air pumps (excluding fuel stations which usually have air pumps and bicycle vent adapters as well)
  • bicycleTubeVending => Bicycle tube vending machines
  • drinkingWater => Drinking water fountains