Skip to content

seanoshea/BostonFreedomTrail

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

436 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Boston Freedom Trail

A comprehensive iOS application for exploring Boston's historic Freedom Trail with interactive maps, GPS navigation, and rich historical content.

CI PRs Welcome License Swift Version iOS Version Languages Top Language Open Issues Closed Issues Twitter: @seanoshea

Overview

The Boston Freedom Trail app transforms your iPhone or iPad into an interactive guide for one of America's most important historical walking tours. Follow the red-brick path through downtown Boston and discover 16 historically significant sites that tell the story of the American Revolution.

Quick Start

# Clone the repository
git clone https://github.com/seanoshea/BostonFreedomTrail.git
cd BostonFreedomTrail

# Install dependencies
bundle install
pod install

# Set up API keys (see DEVELOPMENT.md for details)
cp .env.example .env
# Edit .env with your API keys

# Inject API keys and run
bundle exec fastlane setup
open BostonFreedomTrail.xcworkspace

Features

Core Functionality

  • 📍 Interactive Map - Explore all 16 Freedom Trail locations with custom markers and the iconic red-brick path overlay
  • 🔍 Historical Details - Rich HTML content for each site with historical context, significance, and imagery
  • 🗺️ GPS Navigation - Real-time location tracking to guide you along the 2.5-mile trail through downtown Boston
  • 👁️ Virtual Tour - Immersive Google Street View integration with guided camera positioning for optimal viewing

Technical Features

  • 📱 Native iOS - Built with Swift 6.0, optimized for iPhone and iPad running iOS 18.0+
  • 🏛️ Offline Support - Trail data and historical content available without internet connection
  • 🎯 Location Awareness - Automatic positioning and zoom level restoration based on user's last interaction
  • 📊 Analytics Integration - Firebase Analytics for usage tracking and app improvement insights
  • 🔒 Security First - API key protection, automated security scanning, and secure build processes

For Developers

Interested in contributing or running the project locally? Check out our Development Guide for detailed setup instructions including API key configuration and security requirements.

Contributing

We welcome contributions! Please see our Contributing Guidelines and Development Guide to get started.

Beta Builds

If you're interested in access to beta-builds of the application, send an email to oshea.ie@gmail.com

License

See LICENSE for details.

About

Swift based iOS App for the Boston Freedom Trail

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors