Skip to content

Latest commit

 

History

History
102 lines (65 loc) · 4.08 KB

README.md

File metadata and controls

102 lines (65 loc) · 4.08 KB
Raw

SnapHunt


Logo

Get it on Google Play

SnapHunt is a scavenger hunt game where a player can invite other players on a real world scavenger hunt while using the app as the item identifier by taking a picture of it. Using machine learning technology, the app identifies and scores the player according. Users can play solo or with a group. First player to complete the scavenger hunt or the player the the highest score after countdown ends wins.

A Flutter PH Hackathon 2019 Entry!

Features

  • Single player Scavenger hunt

  • Multiplayer Scavenger hunt

  • Login via Google Authentication

  • Offline Machine learning using ML Kit

  • Multiplayer games using Firestore

  • Join room via QR code

  • Real time score updates in-game

  • Pre defined words using Hive

  • Update words via Firestore console

  • Share results with your friends

    Screenshots

Download & Install

You may install SnapHunt via PlayStore, installing the apk from the release section, or build the app yourself.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Download either Android Studio or Visual Studio Code, with their respective Flutter editor plugins. For more information about Flutter installation procedure, check the official install guide.

Steps

  1. Clone the repository with the 'clone' command, or just download the zip.
$ git clone https://github.com/snap-hunt/snaphunt.git

  1. Install dependencies from pubspec.yaml by running flutter packages get from the project root (see using packages documentation for details and how to do this in the editor).

  2. Follow Option 1 instructions here up to Step 3. Be sure to configure your SHA-1 or SHA-256 hash in the Firebase Project Settings for your app.

  3. Place the downloaded 'google-services.json' file from Step 1 above in your projects /android/app/ directory.

  4. Go to the Firebase Console and then to the Authentication section and then on to the "Sign-in method" tab an enable Email/Password and Google Sign in methods.

  5. Configure Firestore in your Firebase console

  6. Add words collection with words document side.

  7. Inside the words document, add version with int value 1. And words array with the words the app with be using.

  8. Build the app!

Built With

Contributing

Contributions are welcome! Submit an issue for discussion and a PR for the code.

Note: Code is dirty and rushed. This was made in our free time in the short duration of the hackathon. Don't judge us too harshly :D

Authors

  • Justin Enerio
  • Edbert Estevez
  • Dale Moncayo
  • King Montayre

See also the list of contributors who participated in this project.

License

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

Acknowledgments

  • Flutter PH for hosting this hackathon