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 fully deployable, config-driven web app for local food-week events. Fork the repo, edit one config file, and you have a live interactive map with search, dietary filters, restaurant popups, directions, a stats leaderboard, and an embeddable widget — all with zero build tooling, no npm, and no framework.

Introduction

Learn what the map does and what you’ll end up with after forking

Quickstart

Fork, configure, and deploy your first event map in minutes

Configuration Reference

Every field in config.js — types, defaults, and what each controls

Worker API

Cloudflare Worker endpoints for tracking events and reading stats

​
What you’ll build

Fork this repo and you get a fully working event map with:
  • Interactive Leaflet map — color-coded area markers, clustering, and popup cards with menu items
  • Filterable sidebar — search by name, filter by area, dietary tags (vegetarian, gluten-free, fries), and live hours (open now, lunch, dinner)
  • Stats dashboard — per-restaurant engagement leaderboard backed by Cloudflare Analytics Engine
  • Embeddable widget — drop an iframe onto any news site or blog
  • Automated hours — Google Places API fetches opening hours daily via GitHub Actions
  • Zero build step — plain HTML, CSS, and vanilla JS; serve directly from GitHub Pages
1

Fork the repo

Fork samgutentag/sbburgerweek on GitHub and clone it locally.
2

Edit config.js

Set your event name, dates, emoji, map center, and site URL in config.js — this is the single source of truth for your event’s identity.
3

Add your restaurants

Edit data.js (skeleton) and create data-YYYY.js (full details) with your participating restaurants, coordinates, and menu items.
4

Run apply-theme.py and deploy

Run python3 apply-theme.py to regenerate the OG image and update HTML, then push to GitHub Pages.

Restaurant Data

Data file format, restaurant schema, and area color definitions

GitHub Pages Deploy

Deploy your map to GitHub Pages in two minutes

Click Tracking

Set up the Cloudflare Worker for per-restaurant engagement tracking

Restaurant Hours

Fetch live hours from Google Places API via GitHub Actions

Embed Widget

Embed the interactive map on news sites and blogs via iframe

Event Checklist

Step-by-step activation checklist for event day

Build docs developers (and LLMs) love

Get started for freeTalk to us