Skip to content

Commit e746331

Browse files
author
Joe Rowley (jrowley)
committed
Updating readme with api information
1 parent 9fd5bc4 commit e746331

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,5 @@ captures/
3535
.idea/libraries
3636
*.iml
3737
*.original
38+
39+
apikeys.xml

README.md

+12-14
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ This project is meant to support a Code Camp talk on one effective method for im
44

55
Branches
66
---
7-
87
The project is broken up into a couple of branches for the purpose of demonstration.
98

109
####Master
11-
1210
The master branch is the starting point, and doesn't actually have much of use other than a bare project and this README. Maybe at some point one of the other branches will be merged into master, but for now it will be kept separate.
1311

1412
####Standard
15-
1613
The standard branch holds the starting point for the discussion, what I consider to be the "standard" way of building an Android app. This version of the app is build according to most tutorials and documented examples that are available. This includes the Android version of and MVC architecture with very prominent Activities and Fragments that handle much of the view and business logic for the app. It also includes using Loaders for data loading and maybe even an AsyncTask or two. Some great tools can be included in this type of archictecture, including Dagger and RxAndroid to name just a couple.
1714

18-
This style of application works well. There are countless wonderful apps built in this way, including most of the apps that I have built or worked on. But it presents a few challenges. Primarily, Android is notoriously difficult to test because so much is wrapped up in components that require instrumentation. If you're like me you use this as a really great excuse: <br />*"I would love to unit test my app, but you just can't unit test Android."* <br />Developer absolved!
15+
This style of application works well. There are countless wonderful apps built in this way, including most of the apps that I have built or worked on. But it presents a few challenges. Primarily, Android is notoriously difficult to test because so much is wrapped up in components that require instrumentation. If you're like me you use this as a really great excuse:
16+
*"I would love to unit test my app, but you just can't unit test Android."*
17+
Developer absolved!
1918

2019
####MVPI
2120

@@ -27,26 +26,25 @@ But the result is that much of the infrastructure can now be either agnostic of
2726

2827
Dependencies
2928
---
30-
3129
For version numbers and build variant usage see app/build.gradle
3230

33-
| Name | Provider | Summary |
34-
|:--------------------:|:-----------:|:---------------------------------------------------------------------------:|
35-
| | | |
36-
| | | |
37-
38-
To Do ;)
31+
| Name | Provider | Summary |
32+
|:--------------------:|:-----------:|:-------:|
33+
| J-Unit | | Support for java unit testing |
34+
| Android Appcompat v7 | Google | Backwards compatibility library |
3935

4036
API Used In the App
4137
---
42-
To Do ;)
38+
This app uses the Demographic Statistics by Zip Code api provided by New York City. API documentation is found [here] (https://dev.socrata.com/foundry/data.cityofnewyork.us/rreq-n6zk).
39+
40+
The app will require an app token, which can be obtained by going to that page. Once there you will need to create an account, then set up an application. This key should go into string resources named *app_token*.
41+
42+
This api provides a fairly diverse set of data points for each of the zip codes within the boundaries of NYC. It's simple data, general consisting of a field name and a numeric value. This allows us to focus a lot more on the app and its architecture than on working with complex data in an example app.
4343

4444
AndroidStudio and Gradle
4545
---
46-
4746
This project was set up on Android Studio 2.0 and using Gradle 2.8, but should work with most current versions of either
4847

4948
Presentation Slides
5049
---
51-
5250
To Do ;)

0 commit comments

Comments
 (0)