<commit_before>Forage [![LICENSE](https://img.shields.io/badge/License-Mozilla-blue.svg?style=flat)](http://mozilla.org/MPL/2.0/) [![API](https://img.shields.io/badge/API-16%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=16)
======
> A geocaching Android app using MVP architecture and modern libraries 

_This project is currently under heavy development!_

This is my first Android project in order to learn the Android SDK and relevant Android libraries. Please critique my code! If you are just starting with Android check out [this wiki page](https://github.com/Plastix/Forage/wiki/Android-Learning-Resources) for a comphrensive list of learning resources that I used. 

Libraries
-------
* [Dagger 2](http://google.github.io/dagger/)
* [Retrofit 2](http://square.github.io/retrofit/)
* [RxJava](https://github.com/ReactiveX/RxJava) and [RxAndroid](https://github.com/ReactiveX/RxAndroid)
* [Butterknife](http://jakewharton.github.io/butterknife/)
* [Realm](https://realm.io/)
* [Android Iconics](https://github.com/mikepenz/Android-Iconics)
* [Icepick](https://github.com/frankiesardo/icepick)
* [Google Support Libraries](http://developer.android.com/tools/support-library/index.html)
* [Google Play Location Services](https://developers.google.com/android/reference/com/google/android/gms/location/package-summary)
* [Google Play Maps](https://developers.google.com/maps/documentation/android-api/)

Requirements
-------
API keys are not stored in the repo! If you want to build the project yourself you need the following:

1. OkApi (US) key
2. Google Maps Android API key

Create a `local.properties` file in the root directory of the project and add the following to it:<commit_msg>Update build requirements in README<commit_after>Forage [![LICENSE](https://img.shields.io/badge/License-Mozilla-blue.svg?style=flat)](http://mozilla.org/MPL/2.0/) [![API](https://img.shields.io/badge/API-16%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=16)
======
> A geocaching Android app using MVP architecture and modern libraries 

_This project is currently under heavy development!_

This is my first Android project in order to learn the Android SDK and relevant Android libraries. Please critique my code! If you are just starting with Android check out [this wiki page](https://github.com/Plastix/Forage/wiki/Android-Learning-Resources) for a comphrensive list of learning resources that I used. 

Libraries
-------
* [Dagger 2](http://google.github.io/dagger/)
* [Retrofit 2](http://square.github.io/retrofit/)
* [RxJava](https://github.com/ReactiveX/RxJava) and [RxAndroid](https://github.com/ReactiveX/RxAndroid)
* [Butterknife](http://jakewharton.github.io/butterknife/)
* [Realm](https://realm.io/)
* [Android Iconics](https://github.com/mikepenz/Android-Iconics)
* [Icepick](https://github.com/frankiesardo/icepick)
* [Google Support Libraries](http://developer.android.com/tools/support-library/index.html)
* [Google Play Location Services](https://developers.google.com/android/reference/com/google/android/gms/location/package-summary)
* [Google Play Maps](https://developers.google.com/maps/documentation/android-api/)

Requirements
-------
To compile and run the project you'll need:

- [Android SDK](http://developer.android.com/sdk/index.html).
- [Android Marshmallow (API 23)](http://developer.android.com/tools/revisions/platforms.html#5.1).
- Android SDK Tools
- Android SDK Build tools 23.0.2
- Android Support Repository
- Android Support libraries
- JDK 7
- Valid API keys

API keys are not stored in the repo! Thus, you will need the following API keys:

1. [OkApi (US) key](http://www.opencaching.us/)
2. [Google Maps Android API key](https://developers.google.com/maps/documentation/android-api/)

Create a `local.properties` file in the root directory of the project and add the following to it:
{'fraction_non_alphanumeric': 0.14680796071336263, 'fraction_numerical': 0.008012406306539157, 'mean_word_length': 4.863636363636363, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 23, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1708589', 'n_tokens_mistral': 1239, 'n_tokens_neox': 1172, 'n_words': 300}