Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 2.11 KB
Raw

Thank you for your interest!

First thing first, read DESIGN.md to understand how the project is structured.

Compiling

Flutter

Set up Flutter.

If Android Studio complains that the Dart SDK is not installed, point it to ~/development/flutter/bin/cache/dart-sdk (~/development/flutter beingfire the directory where you installed Flutter).

If flutter doctor complains about Android licenses, run

flutter doctor --android-licenses

Google Civic Information API

  1. Acquire an API key for Places API.
  2. Copy lib/credentials.dart.template to lib/credentials.dart and put Google API key in it.

Firebase

  1. In Firebase console, find the project you created for Google Civic Information API .

For Android:

- Project Overview → Add App → Android.
- Put `com.getballot.guide.staging` as package name
- Download `google-services.json`. Move to `android/app`.

For IOS:

- Project Overview → Add App → IOS.
- Put `com.getballot.staging` as package name
- Download `GoogleServices-Info.plist`. Move to `ios/Runner`.
  1. Authentication → Sign-in method → enable Google and Anonymous
  2. Database → Get Started

Android Studio

After you fork and clone the project, Open (instead of import) in Android Studio.

On the toolbar, click on the down triangle next to main.dart. Select Edit Configurations.... Set Build flavor to staging.

Xcode

After you fork and clone the project, Open Runner.xcworkspace.

Before compliing and running the app, go to: File > Workplace Settings > Build System: Legacy Build System (It’s on New Build System by default)

This makes sure the legacy code is read properly.

Now run the app.

Issues

Before writing any code, please comment on the corresponding issue to clarify what needs to be done and how you plan to do it. Create an issue if needed.