|
| 1 | +# Android Bootstrap App |
| 2 | + |
| 3 | +This repository contains the source code for the [Android Bootstrap](http://www.androidbootstrap.com/) |
| 4 | +Android app available from [Google Play](https://play.google.com/store/apps/details?id=com.donnfelker.android.bootstrap). |
| 5 | + |
| 6 | +Please see the [issues](https://github.com/donnfelker/android-bootstrap/issues) section |
| 7 | +to report any bugs or feature requests and to see the list of known issues. |
| 8 | + |
| 9 | +<a href="https://play.google.com/store/apps/details?id=com.donnfelker.android.bootstrap" alt="Download from Google Play"> |
| 10 | + Download from Google Play |
| 11 | +</a> |
| 12 | + |
| 13 | +## License |
| 14 | + |
| 15 | +* [Apache Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) |
| 16 | + |
| 17 | + |
| 18 | +Copyright 2012 Donn Felker |
| 19 | +Copyright 2012 GitHub Inc. |
| 20 | + |
| 21 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 22 | +you may not use this file except in compliance with the License. |
| 23 | +You may obtain a copy of the License at |
| 24 | + |
| 25 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 26 | + |
| 27 | +Unless required by applicable law or agreed to in writing, software |
| 28 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 29 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 30 | +See the License for the specific language governing permissions and |
| 31 | +limitations under the License. |
| 32 | + |
| 33 | + |
| 34 | +## Building |
| 35 | + |
| 36 | +The build requires [Maven](http://maven.apache.org/download.html) |
| 37 | +v3.0.3+ and the [Android SDK](http://developer.android.com/sdk/index.html) |
| 38 | +to be installed in your development environment. In addition you'll need to set |
| 39 | +the `ANDROID_HOME` environment variable to the location of your SDK: |
| 40 | + |
| 41 | + export ANDROID_HOME=/home/roberto/tools/android-sdk |
| 42 | + |
| 43 | +After satisfying those requirements, the build is pretty simple: |
| 44 | + |
| 45 | +* Run `mvn clean package` from the `app` directory to build the APK only |
| 46 | +* Run `mvn clean install` from the root directory to build the app and also run |
| 47 | + the integration tests, this requires a connected Android device or running |
| 48 | + emulator |
| 49 | + |
| 50 | +You might find that your device doesn't let you install your build if you |
| 51 | +already have the version from the Android Market installed. This is standard |
| 52 | +Android security as it it won't let you directly replace an app that's been |
| 53 | +signed with a different key. Manually uninstall Android Bootstrap from your device and |
| 54 | +you will then be able to install your own built version. |
| 55 | + |
| 56 | +## Acknowledgements |
| 57 | + |
| 58 | +Android Bootstrap is a result of a template project I've developed over the years as well as |
| 59 | +a combination of a lot of great work that the [GitHub Gaug.es](http://www.github.com/github/gauges-android) |
| 60 | +app and [GitHub Android](http://www.github.com/github/android) app showcased. Some fo the |
| 61 | +code in this project is based on the GitHub Gaug.es and GitHub Android app. |
| 62 | + |
| 63 | +Android Bootstrap is built on the awesome [Parse.com API](http://www.parse.com/) |
| 64 | +and uses many great open-source libraries from the Android dev community: |
| 65 | + |
| 66 | +* [ActionBarSherlock](https://github.com/JakeWharton/ActionBarSherlock) for a |
| 67 | + consistent, great looking header across all Android platforms, |
| 68 | + [ViewPagerIndicator](https://github.com/JakeWharton/Android-ViewPagerIndicator) |
| 69 | + for swiping between content, traffic, & referrer pages, and |
| 70 | + [NineOldAndroids](https://github.com/JakeWharton/NineOldAndroids) for the |
| 71 | + AirTraffic view animations - all from [Jake Wharton](http://jakewharton.com/). |
| 72 | +* [RoboGuice](http://code.google.com/p/roboguice/) for dependency-injection. |
| 73 | +* [Robotium](http://code.google.com/p/robotium/) |
| 74 | + for driving our app during integration tests. |
| 75 | +* [android-maven-plugin](https://github.com/jayway/maven-android-plugin) |
| 76 | + for automating our build and producing release-ready APKs. |
| 77 | +* [http-request](https://github.com/kevinsawicki/http-request) for interacting with |
| 78 | + remote HTTP resources (API's in this case). |
| 79 | +* [google-gson](http://code.google.com/p/google-gson/) for consuming JSON and hydrating |
| 80 | + POJO's for use in the app. |
| 81 | + |
| 82 | + |
| 83 | +## Contributing |
| 84 | + |
| 85 | +Please fork this repository and contribute back using |
| 86 | +[pull requests](https://github.com/donnfelker/android-bootstrap/pulls). |
| 87 | + |
| 88 | +Any contributions, large or small, major features, bug fixes, additional |
| 89 | +language translations, unit/integration tests are welcomed and appreciated |
| 90 | +but will be thoroughly reviewed and discussed. |
| 91 | + |
| 92 | +I hope this helps you in building your next android app. |
0 commit comments