Skip to content

tractorjuice/livemapper

 
 

Repository files navigation

LiveMapper Monorepo

This repository contains the LiveMapper project - a real-time GPS vehicle tracking application with interactive mapping.

Project Structure

codespaces-react/
├── livemapper/              # Main LiveMapper application
│   ├── src/                 # React/TypeScript source code
│   ├── tests/               # E2E and unit tests
│   └── README.md            # Detailed project documentation
├── specs/                   # Feature specifications
│   └── 001-modern-web-responsive/
│       ├── spec.md          # Feature specification
│       ├── plan.md          # Implementation plan
│       ├── tasks.md         # Task breakdown
│       └── contracts/       # API contracts
└── CONTRIBUTING.md          # Git workflow and contribution guidelines

Quick Start

Navigate to the LiveMapper application directory:

cd livemapper
pnpm install
pnpm run dev

Open http://localhost:3001 to view the application.

Documentation

Primary Documentation: See livemapper/README.md for:

  • Complete feature overview
  • Installation and configuration
  • Architecture documentation
  • API integration details
  • Testing and performance metrics
  • Troubleshooting guide

Contributing: See CONTRIBUTING.md for:

  • Git workflow (main/development/feature branches)
  • Commit conventions
  • Pull request process

Specifications: See specs/001-modern-web-responsive/ for:

  • Feature specifications
  • Implementation plans
  • API contracts

What is LiveMapper?

LiveMapper is a production-ready React application that provides live vehicle tracking using the GPS Live API. It features:

  • Real-time vehicle tracking with 5-second updates
  • Interactive maps powered by Leaflet and OpenStreetMap
  • Smart polling that pauses when browser tab is hidden
  • Status indicators with color-coded markers (active/idle/offline)
  • Marker clustering for large fleets (500+ vehicles)
  • CORS proxy for seamless API integration
  • Mock data mode for development and testing

Technology Stack

Category Technology
Frontend React 18 + TypeScript 5.x
Build Vite 5.x
Mapping Leaflet 1.9.4 + React-Leaflet 4.2.1
HTTP Axios with retry logic
Styling Styled-Components
State React Context API
Testing Vitest + Playwright

Git Workflow

This project uses a structured Git workflow:

  • main - Production-ready code (protected)
  • development - Active development branch
  • feature/* - Feature branches

All development should target the development branch, not main.

See CONTRIBUTING.md for complete workflow details.

Current Status

Phase 1-3 Complete: MVP with real-time tracking, map UI, and GPS Live API integration

Next Phase: Filter & Search (vehicle filtering and search functionality)

Development with SpecKit

This project uses SpecKit, a specification-driven development workflow for building features systematically.

What is SpecKit?

SpecKit provides slash commands in Claude Code for structured feature development:

  • /speckit.specify - Create feature specifications
  • /speckit.plan - Generate implementation plans
  • /speckit.tasks - Break down into actionable tasks
  • /speckit.implement - Execute the implementation
  • /speckit.analyze - Verify consistency and quality

Why SpecKit?

Using SpecKit for LiveMapper provided:

Clear Planning - Features specified before implementation ✅ Risk Mitigation - Technical challenges identified early ✅ Phased Development - 8 phases from MVP to full feature set ✅ Quality Documentation - Auto-generated architecture docs ✅ Easy Onboarding - New contributors understand features quickly

SpecKit Artifacts

All specifications are in /specs/001-modern-web-responsive/:

  • spec.md - Feature requirements and acceptance criteria
  • plan.md - Technical design and architecture decisions
  • tasks.md - Phase-based task breakdown
  • constitution.md - Project principles and guidelines
  • contracts/ - API contracts and interface definitions

See livemapper/README.md for detailed SpecKit workflow documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support


Built with ❤️ using React, TypeScript, and Leaflet

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 61.6%
  • Shell 37.8%
  • HTML 0.6%