Skip to content

SDP-GeoHunt/geo-hunt

Repository files navigation

GeoHunt - Android App Project in Kotlin with Jetpack Compose

The GeoHunt project is an Android game developed in Kotlin that encourages users to explore new locations by taking pictures of their surroundings and challenging other users to find and reach the location where the picture was taken. Users can register and create their account, take pictures and upload them to the game's server, view a list of their active challenges, and view the leaderboard to see who has the most points. The game is designed to be fun, interactive, and engaging, and to provide users with an opportunity to discover new places and environments while enjoying a game. Overall, the GeoHunt project is a unique and innovative way to explore the world around us while having fun with other players.

How to Play

Solo gameplay

  1. Users take a picture of their current location and upload it to the game's server.
  2. Other users must find and go to the location where the picture was taken and claim the challenge.
  3. The closer the user gets to the actual location, the higher the points they earn.
  4. Users can view the game's leaderboard to see who has the most points.

Team gameplay

Bounties are a collection of challenges that players can solve in a team. Very similar to the solo gameplay except that everything is done as a team.

For every bounty, an administrator is responsible for creating challenges.

Features

  • Users can register and create their account
  • Users can take pictures and upload them to the game's server
  • Users can view a list of their active challenges.
  • Users can view the leaderboard to see who has the most points.
  • Users can play in a team in bounties.
  • Users can see a map of all the challenges in their current area.

Contributing Guidelines

Thank you for considering contributing to our project repository! To ensure the confidentiality and security of our codebase, we have some guidelines for contributing that we ask you to follow:

  1. Make sure your code follows the project's code style and best practices.
  2. Write clear and concise commit messages that describe the changes you made.
  3. When adding new features or fixing bugs, make sure to write tests and ensure all existing tests pass.
  4. If your contribution changes any existing functionality, make sure to update the project's documentation accordingly.
  5. Submit a pull request and wait for contributors to review your changes.

Code Style and Best Practices

  • Use Kotlin coding standards and best practices. See the Kotlin coding convention for further general information.
  • Follow the project's code style guide and best practices.
  • Keep your code clean, concise, and easy to read.
  • Use meaningful variable names and comments to explain your code.
  • Use proper exception handling to ensure code reliability.
  • Write tests to ensure the reliability of your code.
  • Avoid using third-party libraries unless necessary.
  • Keep code modular and follow separation of concerns.

Team

This app has been done by the following members:

  • Alban
  • Guillaume
  • Marwan
  • Dario
  • Kishlay
  • Nicolas Tomasz