Skip to content

bopjesvla/hitch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5a0955d · Mar 2, 2025
Feb 1, 2025
Feb 28, 2025
Feb 28, 2025
Jan 22, 2025
Mar 2, 2025
Feb 22, 2025
Feb 23, 2025
Feb 27, 2025
Jan 22, 2025
Nov 14, 2022
Jan 25, 2025
Feb 27, 2025
Feb 8, 2025
Feb 28, 2025
Feb 18, 2025
Feb 18, 2025
Feb 8, 2025
Feb 1, 2025
Feb 28, 2025

Repository files navigation

Hitchmap

The map to hitchhiking the world. Read more here.

Description

Hitchmap is a static site generator that runs every few minutes.

  • server.py runs the server
  • scripts/show.py builds the main HTML page (index.html). This is where the magic happens.
  • scripts/dump.py runs the monthly dump
  • cron.sh is the crontab running above files
  • hitchmap.conf is the NGINX configuration
  • js/map.js is the entry point of the homepage's JavaScript
  • js/pending.js is responsible for adding temporary markers

A few developers have taken it upon themselves to rewrite Hitchmap to a more traditional MVC structure.

For contributors and users, we recommend reviewing both repositories to determine which best fits your needs. In virtually all cases, user-facing contributions will eventually end up in both repositories.

License

The software provided in this repository is licensed under AGPL 3.0. The Hitchmap database is licensed under the ODBL, the license used by OpenStreetMap.

Installation (on Linux)

Install Python and Node.js, then:

python3 -m venv .venv # optional
source .venv/bin/activate # optional

pip install -r requirements.txt
curl https://hitchmap.com/dump.sqlite > db/points.sqlite
npm install
npm run build

Getting started

Running

python3 scripts/show.py
python3 server.py

Linting

We use Ruff for linting https://docs.astral.sh/ruff/.

The settings can be found in ruff.toml.

To configure automatic linting for VS Code check out the extension https://github.com/astral-sh/ruff-vscode.

Contributing

Join the conversation about a map for hitchhiking in our Signal Chat.

File an issue if you have a feature request or found a bug.

Perform a pull request from your fork of the repository if you solved an issue. (It's best to file an issue first so we can discuss it and reference it in the PR.)

Data

If you find the data collected and provided by hitchmap.com helpful, feel free to cite it using:

@misc{hitchhiking,
author = {Bob de Ruiter, Till Wenke},
title = {Dataset of Hitchhiking Trips},
year = {2024},
url = {https://hitchmap.com},
}