iamantoniodinuzzo/Pothole-Client

A native Android application using the Java language that can locate a user on a map, track their movements by recognizing any potholes in the road surface making use of the accelerometer.

Pothole

A native Android application using the Java language that can locate a user on a map, track their movements by recognizing any potholes in the road surface making use of the accelerometer.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

Login	Map	Settings	Tracking

The system stores and makes available a list of events generated by clients regarding the detection of a pothole on the road surface. Each client is identified by a nickname, chosen by the user.

(back to top)

Built With

• Java
• Jetpack Navigation Component
• View Binding
• Data Binding
• ViewModel
• AndroidX Preference Library

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

1. Get a free API Key at Google Maps API
2. Clone the client repo

   git clone https://github.com/Indisparte/Pothole-Client.git

3. Enter your Map API in local.properties

   MAPS_API_KEY="MY_KEY"

4. Clone the server repo

   git clone https://github.com/Indisparte/Pothole-Server.git

5. Set IP server address and PORT in local.properties

   SERVER_ADDRESS="server_ip_address"
   SERVER_PORT="server_port"

(back to top)

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.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Allow the user to initiate an event logging session during which the client connects to the server, receives threshold parameters, and tells the server the location and value of the change each time it records a new event.

• Show the user a list of all events recorded by the server within a certain radius from their location.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)