Skip to content

t07que/Golfr

Repository files navigation

GolfMap

GolfMap is a map-first web app for discovering golf venues (clubs, resorts, and centres) with facility-based filtering and rich venue details.

Tech Stack

  • Vite + React + TypeScript
  • TailwindCSS + shadcn/ui-style components
  • react-leaflet + marker clustering (OpenStreetMap tiles)
  • Zod schema validation shared by app and data validator script
  • ESLint + Prettier + Vitest

Prerequisites

  • Node.js 20+
  • npm 10+

Install

npm i

Run Dev Server

npm run dev

Build

npm run build

Lint

npm run lint

Format

npm run format

Validate Data

npm run validate:data

Validation checks include:

  • Zod schema conformance
  • unique venue IDs across seed + addon files
  • valid latitude/longitude ranges
  • at least one course per venue
  • HTTPS website URL
  • non-empty source URLs

Test

npm run test

Data Files

  • src/data/venues.seed.json - base seeded dataset (Bridgend area)
  • src/data/venues.addons/*.json - additive dataset batches loaded automatically
  • src/data/scrape-manifest.json - scraper ledger to prevent duplicate crawl batches
  • src/data/venue.schema.ts - schema + TS types
  • src/data/venues.template.json - starter template for new venues
  • src/data/README.md - field-level documentation

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors