Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.49 KB

README.md

File metadata and controls

49 lines (30 loc) · 2.49 KB
Raw

HelloVoter Mobile App

Find this app on the Google Play Store (Android) and the Apple Store (iPhone).

Production Deployment

Our Voice USA pushes regular releases to the app stores. Our desire is to collaborate on changes you may require in this mobile app and publish them in HelloVoter. If however you need to roll your own version of this app, make sure you comply with the license! While this app is open source, that does not make it yours. Things you have to do include (but are not limited to) the following:

  • The license notice in the app must remain in prominent and conspicuous place, accessible prior to any kind of login.
  • You must state next to the notice that this is a modified work of the original.
  • You must provide a link next to the notice that sends the user to the corresponding modified source code.
  • Logos, icons, and other artwork depicting the Our Voice bird are not for redistribution without express written permission by Our Voice USA.

Development Setup

Start by settings up the back-end service - see the civic-broker git repository.

Set up your .env file:

cat << EOF > .env
WS_BASE=YOUR_CIVIC_BROKER_URL
GOOGLE_API_KEY_IOS=YOUR_KEY
GOOGLE_API_KEY_ANDROID=YOUR_KEY
EOF
  • The GOOGLE_API_KEY_ values are credentials created by visiting http://console.developers.google.com/
  • Without these keys, address searches and geocoding won't function, which limits functionality

Install https://nodejs.org/en/download/ if you havne't already, and run:

git clone https://github.com/OurVoiceUSA/HelloVoter.git
cd HelloVoter/mobile/
npm install
npm install -g @react-native-community/cli

If you're developing the Android app - install https://developer.android.com/studio/releases/ if you haven't already, import the HelloVoter/mobile/android project, and follow the prompts to download all the build and runtime dependancies. You'll also have to run this command:

echo "sdk.dir = $HOME/Library/Android/sdk" > android/local.properties

If you're developing the iOS app - simply install the build dependancies with pods:

(cd ios/ && pod install)

You also may need to configure xcode to properly be able to do a xcrun simctl, more information here: https://stackoverflow.com/questions/29108172/xcrun-unable-to-find-simctl

Finally, build the app:

react-native run-ios or react-native run-android