Skip to content

cwo3990/trekvizion

Repository files navigation

TrekVizion

codecov License: MIT Quality Gate Status

TrekVizion is an innovated hiking application that employs image registration to refine the precision of mapped trails. This transformative technique entails superimposing trail map images onto satellite maps, resulting in heightened image accuracy. By seamlessly integrating these visual layers, TrekVizion not only enhances location tracking but also ensures the safety of its users on their wilderness journeys.

Team Information

  • Team name: TrekVizion
  • Team members
    • Amia Diakite - admdiakit-su
    • Connor O'Neill - cwo3990
    • Amir Hassanzadeh - amirhszd
    • William Dabney - whd8254
    • Dmitrii Korobeinikov - dmitrykoro

Documentation

The Design Document for this project outlines the project's architecture, features, and use cases. It can be found here.

Minimum Requirements

  • Flutter SDK latest
  • Android Studio latest (for Android development)
    • Android SDK Platform, API latest
    • Android SDK Command-line Tools
    • Android SDK Build-Tools
    • Android SDK Platform-Tools
    • Android Emulator
  • Xcode latest (for iOS development) (not implemented yet)
  • Your favorite text editor (optional)

How to run it

  1. Install Flutter SDK:

    • Download and install the Flutter SDK from the official Flutter website.
    • Follow the instructions provided for your specific operating system (Windows, macOS, or Linux).
      • Note: If you're using macOS, you can develop for both iOS and Android. For Windows and Linux, you can only develop for Android, so you can skip the iOS development portions of these instructions.
  2. Set up Flutter Environment:

    • Add Flutter to your system's PATH variable to use Flutter commands globally.
    • Run flutter doctor in your terminal to check if there are any dependencies you need to install.
  3. Install Android Studio (For Android development) / Install Xcode (For iOS development):

    • For Android: Download and install Android Studio from the official website. Follow the setup instructions provided for your operating system. Install the Android SDK and any necessary SDK tools through the Android Studio SDK Manager.
    • For iOS: If you're developing for iOS, install Xcode from the Mac App Store. Ensure Xcode is up to date and you have accepted the license agreement.
  4. Configure Device/Emulator/Simulator:

    • For Android: Set up a physical device or configure an Android emulator through Android Studio AVD Manager. Make sure your device/emulator is connected and recognized by running flutter devices.
    • For iOS: Launch Xcode, open the Preferences window (Cmd + ,), and go to the Components tab. Install a simulator if none are available. Launch an iOS simulator from Xcode or using the flutter emulators command.
  5. Run the App:

    • For Android: Connect your Android device or launch an Android emulator. Run flutter run in the terminal from your project directory to build and run the Flutter app on Android.
    • For iOS: Connect your iOS device or launch an iOS simulator. Run flutter run with the --ios flag for iOS-specific builds.

If everything has been setup correctly, the app should build and run on your device/emulator/simulator, and your screen should look like this:

Android Homepage

Troubleshooting Resources:

Testing

Testing for this project includes unit testing, widget testing, and testing of interations between client and server. To learn more about widgets and testing in Flutter, visit the official documentation.

[Testing screenshot(s)]

About

Our project, TrekVizion, is a hiking app that enables users to overlay an image of a trail map onto a GPS map then track their path as they hike over the very map they captured.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors