Note: This work is licensed under the Apache License 2.0. If you contribute any non-trivial patches or translations make sure you have read it and agree with it.
- Fork SeriesGuide and clone your fork.
- See the notes about building the app below.
- Create a new branch (using GitHub
or the command
git checkout -b descriptive-branch-name dev). - Make great commits.
- Start a pull request and reference issues if needed.
- You can discuss or submit bug reports.
- You can suggest features.
- You can translate the app.
devis the main development and test release branch.mainhas always the latest stable version.
To get started:
- Import the
SeriesGuidefolder as a new project in Android Studio. - Select the
pureDebugbuild variant (defined inapp/build.gradle). Learn about product flavors.
Debug builds should just work.
To add shows or movies you need to create an API key for TMDB
and OAuth credentials for trakt.
Place them in secret.properties in the project directory (where settings.gradle is):
SG_TMDB_API_KEY=<your api key>
SG_TRAKT_CLIENT_ID=<your trakt client id>
SG_TRAKT_CLIENT_SECRET=<your trakt client secret>
To release some additional secret.properties values might be necessary:
# Play Store in-app billing public key
SG_IAP_KEY_A=<keypart>
SG_IAP_KEY_B=<keypart>
SG_IAP_KEY_C=<keypart>
SG_IAP_KEY_D=<keypart>
# Credentials to publish the API jar
SONATYPE_NEXUS_USERNAME=<your sonatype username>
SONATYPE_NEXUS_PASSWORD=<your sonatype password>
To use Crashlytics download and
add your app/google-services.json.