Skip to content

shahriaarrr/mashhad-metro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

59 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš‡ Mashhad Metro

A comprehensive guide to navigate Mashhad Metro system effortlessly

Dart Flutter Riverpod OpenStreetMap License: GPL v3

Features β€’ Screenshots β€’ Download β€’ Build β€’ Contributing β€’ License


πŸ“– About

Mashhad Metro is a free and open-source mobile application designed to help residents and pilgrims navigate the Mashhad Metro system with ease. Built with Flutter, this app provides comprehensive information about all metro stations, lines, facilities, and real-time navigation assistance.

Data Source: This application uses metro station data from the mashhad-metro-data repository, which maintains accurate and up-to-date information about the Mashhad Metro system.

Whether you're a daily commuter or visiting the holy city for the first time, Mashhad Metro is your essential companion for exploring the city's metro network.


✨ Features

  • πŸ—ΊοΈ Interactive Map - View all metro stations on an interactive map with zoom and navigation capabilities
  • πŸ“ Complete Station Information - Access detailed information for each station including addresses and exact locations
  • 🏒 Facilities Finder - Easily locate stations with specific amenities (elevators, restrooms, WiFi, parking, etc.)
  • πŸš‰ Multi-Line Support - Browse all metro lines and identify interchange stations seamlessly
  • πŸ“± Offline Access - Use all station information without an internet connection
  • 🎨 Modern UI/UX - Clean, intuitive interface with dark mode support
  • β™Ώ Accessibility - Designed for users of all ages and abilities
  • πŸ†“ 100% Free & Open Source - No ads, no tracking, no hidden costs

πŸ“± Screenshots

Screenshot 1 Screenshot 2 Screenshot 3 Screenshot 4 Screenshot 5

πŸ“₯ Download

Platform Myket Bazaar Anardoni F-Droid GitHub Releases
Android Myket Bazaar - F-Droid GitHub Release
iOS - - Anardoni - GitHub Release

πŸ› οΈ Build from Source

Prerequisites

Before you begin, ensure you have the following installed:

Steps

  1. Clone the repository
   git clone https://github.com/shahriaarrr/mashhad-metro.git
   cd mashhad-metro
  1. Install dependencies
   flutter pub get
  1. Run the app in debug mode
   flutter run
  1. Build for Android (APK)
   flutter build apk --release

The APK file will be located at: build/app/outputs/flutter-apk/app-release.apk

  1. Build for Android (App Bundle)
   flutter build appbundle --release

The AAB file will be located at: build/app/outputs/bundle/release/app-release.aab

  1. Build for iOS (macOS only)
   flutter build ios --release

Build Configuration

To customize the build, you can modify the following files:

  • android/app/build.gradle - Android build configuration
  • ios/Runner.xcodeproj - iOS build configuration
  • pubspec.yaml - Project dependencies and metadata

🎨 Design Credits

App Icon Design: Sajjad Khiabani

A special thanks to Sajjad for creating the beautiful and modern app icon that perfectly represents the spirit of Mashhad Metro.


⚠️ Found Incorrect Metro Data?

Warning

Important Notice
If you notice any incorrect or outdated information about metro stations, facilities, or routes, please DO NOT report it here.

All metro data is maintained in a separate repository:
πŸ‘‰ mashhad-metro-data

Please report data issues or submit corrections there. This helps keep the data accurate for all applications that use it.


🀝 Contributing

Contributions are welcome! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making Mashhad Metro better.

How to Contribute

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please read our Contributing Guidelines for more details.


πŸ’– Credits

The user interface of this project was inspired by the beautiful design of the Tehran Metro App created by @mosayeb-a.

Their thoughtful approach to creating an intuitive and visually appealing metro navigation experience served as a foundation for this project's design language. We're grateful for their contribution to making public transportation more accessible through great design.


πŸ› Bug Reports

If you encounter any issues, please open an issue with:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)
  • Device information and OS version

πŸ“ž Contact


Made with ❀️ for pilgrims and residents of Mashhad

⭐ If you find this app helpful, please consider giving it a star on GitHub! ⭐