ivancaez / geoquest-mobile

🗺️ A geocaching app

GeoQuest - Mobile

This is the README file for the GeoQuest mobile application, which is part of a larger project. This repository holds the source code of the mobile application, developed using Kotlin language and Retrofit to make the connection between our API and our APP in the Android Studio IDE.

Table of Contents

• Introduction
• Authors
• Features
• Web Application
• Installation
• Usage
• Contributions
• Support
• License

Introduction

GeoQuest Mobile is a mobile application built to provide an immersive and interactive experience based on the player's real-world location. The game allows users to embark on treasure hunts as they explore their surroundings and post their findings.

Authors

Alejandro Arcas Leon

Martí Gustamante Clavell

Ivan Martinez Cañero

Asier Barranco Barbudo

Joel Garcia Galiano

Raul Argemi

Features

• Authentication: Players can log in to their accounts using login credentials.
• Registration: New users can create an account on GeoQuest by providing basic information.
• Real-time Map Integration: The app utilizes real-time map integration to guide users to their quest locations.
• Treasure Details: Players can discover hidden treasures in their surroundings.
• Treasure Hunt: Players can start treasures hunts and leave reviews and comments on the treasures they have discovered.
• Profile Editing: Players have the option to edit their profile, update personal information, and add a profile picture.
• Player Statistics: Players can view their game statistics, including the number of treasures found, their score, and unlocked achievements.
• Favorites: Players can mark treasures as favorites for quick access in the future.

Web Application

This project also includes a complementary GeoQuest web application, where players can create profiles, view statistics and their reviews and discover new treasures. Through the web page, users can access the mobile application, and vice versa, providing flexibility and options to the players.

Installation

To install and set up GeoQuest Mobile on your local development environment, you just hav to clone the repository:

git clone https://gitlab.com/ivan.martinez.7e6/geoquest-mobile.git

Usage

Once the application is up and running, you can use the following instructions to explore its features:

1. Launch the app on your mobile device or emulator.

2. Create a new user account or log in with an existing account.

3. Browse available treasures on the map or in the treasure list.

4. Select a treasure to view its details and start the adventure.

5. Follow the provided map directions to reach the quest location.

6. Read the hint to aid yourself with the hunt.

7. Find the treasures, track your progress and earn achievements.

Contributions

Thank you for considering contributing to GeoQuest! If you would like to contribute to the project, follow these steps:

1. Fork the GeoQuest repository.
2. Create a branch (git checkout -b feature/new-feature) for your contribution.
3. Make the changes and improvements in your local branch.
4. Commit your changes (git commit -am 'Add a new feature').
5. Push your branch (git push origin feature/new-feature).
6. Open a pull request on the original repository and describe your changes in detail.

We appreciate all contributions that help improve GeoQuest and provide a better experience for users.

Support

If you encounter any issues, have questions, or suggestions, feel free to open an issue on the GeoQuest repository. We'll be happy to assist you and resolve any problems you may encounter.

License

The GeoQuest Mobile project is licensed under the MIT License. Feel free to use, modify, and distribute this code as permitted by the license.

Please note that this README template is meant as a starting point. You should update it to accurately reflect the details of your specific project.