This repository contains the source code for the City Lights Android app available from Google Play.
Please see the issues section to report any bugs or feature requests and to see the list of known issues.
Have a questions about City Lights? Ask away on the com-example-vzachos-mapaplication discussion forum.
Learn how to develop with IntelliJ and Gradle.
Log into this demo app with the following credentials:
user: demo@androidbootstrap.com
password: android
Why generate? Simple ... renaming files, folders, copy and pasting is SUPER error prone and well... it sucks overall. This can easily take a few days with debugging if you run into issues and perform a lot of typo's. Using the generator on AndroidBootstrap.com you can generate your application with your application name as well as the package (and folder structure) that you want to work with.
As an example, you know that you want your app name and package to the following:
- App Name: Notify
- Package Name: com.notify.app.mobile
After generating the app on AndroidBootstrap.com the folder structure of the source code for the app will change:
- From: com.example.vzachos.mapaplication
- To: com/notify/app/mobile
At that point all the source files that were located in __com.example.vzachos.mapaplication will be moved to the new folder com/notify/app/mobile.
All import statments that reference the old resources (R.com.example.vzachos.mapaplication.R) will now be renamed to the correct package. The artifact id's in the pom.xml (and various other places) will be replaced. The App Name will be replaced in the strings/etc.
The end result is that you will be given a zip file with the correct structure. Open the zip and then execute the ./gradlew command and your app should be ready for development.
Enjoy!
The application
Copyright 2014 Donn Felker Copyright 2014 GitHub Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
The build requires Gradle
v1.10+ and the Android SDK
to be installed in your development environment. In addition you'll need to set
the ANDROID_HOME environment variable to the location of your SDK:
export ANDROID_HOME=/path/to/your/android-sdk
After satisfying those requirements, the build is pretty simple:
- Run
gradleworgradle assembleDebugorgradle assembleReleasefrom theappdirectory to build the APK only - Run one of the commands above from the root directory to build the app and also run the integration tests, this requires a connected Android device or running emulator.
You might find that your device doesn't let you install your build if you already have the version from the Android Market installed. This is standard Android security as it it won't let you directly replace an app that's been signed with a different key. Manually uninstall City Lights from your device and you will then be able to install your own built version.
Why are you using Eclipse still? :) Please use Android Studio, we do not support Eclipse.
City Lights is a result of a template project I've developed over the years as well as a combination of a lot of great work that the GitHub Gaug.es app and GitHub Android app showcased. Some of the code in this project is based on the GitHub Gaug.es and GitHub Android app.
City Lights is built on the awesome Parse.com API and uses many great open-source libraries from the Android dev community:
- AppCompat for a consistent, great looking header across all Android platforms, ViewPagerIndicator for swiping between fragments and NineOldAndroids for view animations - all from Jake Wharton.
- NavigationDrawer for the menu drawer navigation.
- Dagger for dependency-injection.
- ButterKnife for view injection
- Otto as the event bus
- Robotium for driving our app during integration tests.
- android-maven-plugin for automating our build and producing release-ready APKs.
- Retrofit for interacting with remote HTTP resources (API's in this case).
- google-gson for consuming JSON and hydrating POJO's for use in the app.
Thank you to all the contributors on this project. Your help is much appreciated.
Please fork this repository and contribute back using pull requests.
Any contributions, large or small, major features, bug fixes, additional language translations, unit/integration tests are welcomed and appreciated but will be thoroughly reviewed and discussed.
I hope this helps you in building your next android app.