chancepayne / acmedriverassignment

Acme Driver Assignment

Application that loads a list of drivers and shipments and calculates the most optimized driver assignments based on a top-secret algorithm.

View Demo · Report Bug · Request Feature

Table of Contents

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

Built With

(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

• Android Studio

Installation

1. Clone the repo

   git clone https://github.com/ChancePayne/AcmeDriverAssignment.git

2. Build with Android Studio

Testing

In order to test this app with additional datasets, you can mock the endpoints used in the app. The app is setup for mocking with Proxyman, but you can make adjustments necessary to use your favorite mocking software.

Drivers

GET https://cloud.chenzarchondie.xyz/s/CMs74xQrp99zw8y/download/drivers.json

The endpoint should return a list of strings to match the provided JSON structure.

[
  "Dalinar Kholin",
  "Waxillium Ladrian"
]

Shipments

GET https://cloud.chenzarchondie.xyz/s/3wrz2fm6EexQbQE/download/shipments.json

The endpoint should also return a list of strings to match the provided JSON structure.

[
  "7556 Greenholt Harbors, Lake Eduardotown, HI 28648-1463",
  "5168 Jerrold Fields #458, Muellerchester, WI 14539"
]

This app uses a simple caching system, if you want to mock values be sure to close the app to ensure the mocked values are used instead of the cache

(back to top)

Usage

Launch the app, you will see a list of drivers. Select a driver's name to see their currently assigned shiment.

(back to top)

Roadmap

• Migrate data storage and processing to server

• Improve local caching

• UI/UX updates

  • Integrate with a maps API to display location

• Shipment Details

  • Include additional shipment details for the driver

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

(back to top)

License

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

(back to top)

Contact

Project Link: https://github.com/ChancePayne/AcmeDriverAssignment

(back to top)