White Label ios Application Installation and Customization Guide

Transcription

1 White Label ios Application Installation and Customization Guide

2 Background

3 Background Application built for civic agencies to bring voting information to the public Code written to make deployment easy, without extensive ios development experience

4 Background

5 Background This is your data that Google is serving!

6 Background - API

7 Background - API Response includes: Contest and Referendum Candidate information Polling locations Local voting information

8 Background White Label App not in the App Store, but ready to deploy Customizable text and images Feature complete and ready to go

9 Background Open Source BSD 3-Clause License ios7-white-label-app

10 Basic Requirements Macintosh computer with a recent version of OSX Xcode 5+ (for ios 7 apps) Xcode command line tools installed Technical proficiency on a Mac

11 Setup before you start First, get your API keys: Google Civic Information API Key Google Maps ios SDK API Key Google Directions API Key Google Analytics Tracking ID

12 Setup before you start Google makes this really easy:

13 Setup before you start Google makes this really easy:

14 Setup before you start Google makes this really easy:

15 Setup before you start Google makes this really easy:

16 Setup Dependencies Xcode required for ios development, in the App Store Git should be installed on the Mac with Xcode $ git --help CocoaPods a dependency manager for Objective C projects $ sudo gem install cocoapods

17 Setup get the code Go to Copy the HTTPS clone URL In Terminal, clone the repo: $ git clone

18 Setup install dependencies Navigate to the app s working directory: $ cd ios7-white-label-app/objc/votinginformationproject/ Install dependencies with CocoaPods $ pod install

19 Setup Settings Navigate one more level in: $ cd VotingInformationProject Copy the settings template files $ cp CivicAPIKey.plist.template CivicAPIKey.plist $ cp settings.plist.template settings.plist

20 Setup Settings Open the VotingInformationProject.xcworkspace file

21 Setup Settings In Xcode, in the left sidebar, find and click on VotingInformationProject/ Resources/ settings.plist

22 Setup Settings Get your API keys together and update the.plist file. You can also do this with a plain text editor. Update the GoogleMapsAPIKey, GoogleAnalyticsTrackingID, and GoogleDirectionsAPIKey Also, update the BrandNameText with what you want the app to be called.

23 Setup Settings In Xcode, in the left sidebar, find and click on VotingInformationProject/ Resources/ CivicAPIKey.plist

24 Setup Settings Update your GoogleCivicInfoAPIKey

25 Setup Build the project Click the Play button in the top left of the Xcode window: If everything works, you should get a success message:

26 Run Build the project And the app should start in the Simulator

27 Run Additional Configurations There are a few more things to consider before packaging the app for submittal to the App Store About, Terms, and Privacy Policy content Customized images Additional language support

28 Run Additional Configurations About, Terms, and Privacy Policy content are in Resources/Localizable.strings

29 Run Additional Configurations Edit, save, and rebuild You can change any of the text in Xcode or a plain text editor that supports UTF-16 character encoding.

30 Run Additional Configurations Translations are also in Resources/Localizable.strings Spanish translations are not available yet, but are in progress

31 Run Additional Configurations Additional languages can be added by navigating to the project settings and adding a new language. A new strings file will be created automatically

32 Run Additional Configurations Customize the app s images by updating files in the Resources/Images directory Tips: Use the same name Keep the same pixel dimensions

33 Run Additional Configurations Customize the AppIcons, Background, and LaunchScreen images for a complete visual rebranding. You don t need to change these, though.

34 Publish That s everything for setup and configuration! The next step is to package the app and submit it to the App Store. Apple has lots of documentation on this process.

35 Publish The publishing process requires completing several steps.

36 Publish The documentation is extensive, but comprehensive. There s a quick start guide

37 Publish As well as the complete distribution guide

38 Publish The process takes some time to work through, but isn t particularly difficult. Many of the issues you may encounter are not new, and resolutions can likely be found with a quick Google search. If additional technical support is needed, contact: Jared Marcotte at [email protected]

39 Good luck!

40 White Label ios Application Installation and Customization Guide