Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/samgutentag/sbburgerweek/llms.txt

Use this file to discover all available pages before exploring further.

SB Burger Week Map is a forkable, open-source web app for local food-week events — burger week, taco week, coffee week, or any city-wide dining event you can imagine. It ships as pure HTML, CSS, and JavaScript with no build step, no npm, and no framework dependencies. You edit one config file, run one Python script, push to GitHub, and your map is live on GitHub Pages.

What you get

Interactive Leaflet Map

A full-screen Leaflet map with color-coded CircleMarkers per geographic area and MarkerCluster grouping. Clicking a marker opens a popup with the restaurant’s menu items, dietary tags, contact links, and directions buttons.

Filterable Sidebar

A persistent sidebar with live search, area buttons, dietary tag filters (vegetarian, gluten-free, fries), and time-of-day filters (Open Now, Lunch, Dinner) that appear automatically when hours data is available.

Stats Leaderboard

A /stats dashboard that ranks restaurants by engagement score — combining views, direction clicks, shares, upvotes, website visits, and more — powered by the Cloudflare Analytics Engine.

Embeddable Widget

A self-contained embeddable map at /embed/map with a compact 280 px sidebar, ready to drop into local news sites and blogs as a single <iframe> snippet.

Restaurant Hours

Live open/closed badges and hours in every popup and sidebar card, fetched daily from the Google Places API via a scheduled GitHub Action and gracefully hidden when the data file is absent.

Click Tracking

Per-restaurant engagement tracking (views, directions, shares, upvotes, phone, website, Instagram) via a lightweight Cloudflare Worker writing to Analytics Engine — with an /admin search-query viewer.

Social Preview Image

A branded OG image (og-image.png) generated from an SVG template by apply-theme.py using ImageMagick and Twemoji, so every share on social media shows your event name, dates, and emoji.

Print-Friendly My Picks

A checklist mode that lets visitors mark their must-visit restaurants and print a clean picks page, all persisted to localStorage so nothing is lost on refresh.

What you need

ToolRequired?What For
Git + GitHub accountYesHosting via GitHub Pages
Python 3Yesapply-theme.py and data helper scripts
ImageMagickYesGenerating the social preview PNG (og-image.png)
A text editorYesEditing config.js and restaurant data files
Cloudflare account (free)OptionalWeb analytics and click-tracking Worker
Google Cloud account (free tier)OptionalRestaurant hours via Google Places API
Wrangler CLIOptionalDeploying the Cloudflare tracking Worker
Custom domainOptionalA clean URL instead of username.github.io/sbburgerweek

Tech stack

  • Map rendering: Leaflet + Leaflet.markercluster
  • Basemap tiles: CARTO Voyager (CDN, no API key required)
  • Hosting: GitHub Pages (static, zero-config deploy from the repo root)
  • Click tracking: Cloudflare Worker + Analytics Engine (free tier: 100 k writes/day, 90-day retention)
  • Page analytics: Cloudflare Web Analytics (free, cookieless)
  • Restaurant hours: Google Places API fetched by a daily GitHub Actions workflow
  • Asset generation: Python 3 stdlib + ImageMagick (apply-theme.py)
No npm, no bundler, and no framework are needed. The project is plain static HTML — python3 -m http.server is all you need to develop locally, and GitHub Pages deploys straight from the repo root.

Build docs developers (and LLMs) love