diff --git a/README.md b/README.md index d5ad669..267f0e6 100644 --- a/README.md +++ b/README.md @@ -1,199 +1,79 @@ - - - - - - - -[![Contributors][contributors-shield]][contributors-url] -[![Forks][forks-shield]][forks-url] -[![Stargazers][stars-shield]][stars-url] -[![Issues][issues-shield]][issues-url] -[![MIT License][license-shield]][license-url] -[![LinkedIn][linkedin-shield]][linkedin-url] - - - -

- - Logo - - -

SnapHunt

- -

- YOUR_SHORT_DESCRIPTION -
- Explore the docs » -
-
- View Demo - · - Report Bug - · - Request Feature -

-

- - - - -## Table of Contents - -* [About the Project](#about-the-project) - * [Built With](#built-with) -* [Getting Started](#getting-started) - * [Prerequisites](#prerequisites) - * [Installation](#installation) -* [Usage](#usage) -* [Roadmap](#roadmap) -* [Contributing](#contributing) -* [License](#license) -* [Contact](#contact) -* [Acknowledgements](#acknowledgements) - + Logo +

- -## About The Project -[![Product Name Screen Shot][product-screenshot]](https://example.com) +# SnapHunt -Here's a blank template to get started: -**To avoid retyping too much info. Do a search and replace with your text editor for the following:** -`github_username`, `repo`, `twitter_handle`, `email` +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. -## Features -* Singleplayer Scavenger hunt +* Single player Scavenger hunt * Multiplayer Scavenger hunt * Offline Machine learning using ML Kit * Multiplayer games using Firestore * Real time score updates in-game * Pre defined words using Hive * Update words via Firestore console +* Share results + + -## Getting Started - -To get a local copy up and running follow these simple steps. +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. ### Prerequisites -This is an example of how to list things you need to use the software and how to install them. -* npm -```sh -npm install npm@latest -g -``` +What things you need to install the software and how to install them -### Installation - -1. Clone the repo -```sh -git clone https://github.com/github_username/repo.git ``` -2. Install NPM packages -```sh -npm install +Give examples ``` +### Installing +A step by step series of examples that tell you how to get a development env running - -## Usage - -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. +Say what the step will be -_For more examples, please refer to the [Documentation](https://example.com)_ +``` +Give the example +``` +And repeat +``` +until finished +``` - -## Roadmap +End with an example of getting some data out of the system or using it for a little demo + --> -See the [open issues](https://github.com/github_username/repo/issues) for a list of proposed features (and known issues). +## Built With +* [Flutter](https://flutter.dev/) - <3 +* [Firestore](https://firebase.google.com/docs/firestore) - Realtime Database - ## Contributing -Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. - -1. Fork the Project -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 [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. - -## License - -Distributed under the MIT License. See `LICENSE` for more information. +## Authors +* **Justin Enerio** +* **Edbert Estevez** +* **Dale Moncayo** +* **King Montayre** +See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. - -## Contact - -Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email - -Project Link: [https://github.com/github_username/repo](https://github.com/github_username/repo) - - - - -## Acknowledgements - -* []() -* []() -* []() - - +## License +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details +## Acknowledgments - - -[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=flat-square -[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors -[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=flat-square -[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members -[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=flat-square -[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers -[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square -[issues-url]: https://github.com/othneildrew/Best-README-Template/issues -[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square -[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt -[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 -[linkedin-url]: https://linkedin.com/in/othneildrew -[product-screenshot]: images/screenshot.png +* Flutter PH for hosting this hackathon diff --git a/screenshots/1.jpg b/screenshots/1.jpg new file mode 100644 index 0000000..7adee4c Binary files /dev/null and b/screenshots/1.jpg differ diff --git a/screenshots/2.jpg b/screenshots/2.jpg new file mode 100644 index 0000000..57fe74c Binary files /dev/null and b/screenshots/2.jpg differ diff --git a/screenshots/3.jpg b/screenshots/3.jpg new file mode 100644 index 0000000..cc355ae Binary files /dev/null and b/screenshots/3.jpg differ diff --git a/screenshots/4.jpg b/screenshots/4.jpg new file mode 100644 index 0000000..45759f3 Binary files /dev/null and b/screenshots/4.jpg differ diff --git a/screenshots/5.jpg b/screenshots/5.jpg new file mode 100644 index 0000000..3b83322 Binary files /dev/null and b/screenshots/5.jpg differ diff --git a/screenshots/snap.png b/screenshots/snap.png new file mode 100644 index 0000000..c639a4b Binary files /dev/null and b/screenshots/snap.png differ