Skip to content
Permalink
Browse files

update the setup and README docs

  • Loading branch information...
quiro91 committed Apr 7, 2018
1 parent 4fba4ae commit 0b4ee4207dec9a08684f5927459f21bd7be3b3fc
Showing with 6 additions and 7 deletions.
  1. +1 −1 README.md
  2. +5 −6 docs/setup.md
@@ -12,7 +12,7 @@ detailed instructions.

Please note that this app uses some third party services:
* Firebase (Firestore, Push messages, etc.)
* Fabric: Crashlytics and Twitter
* Fabric: Crashlytics

While not all of them are strictly necessary for the app to work (with the exception of Firebase's RTDB), it is currently not possible for the code to
work without them. We plan on eventually abstracting away the implementations so that they would simply be disabled if there is no API configured, but
@@ -11,8 +11,7 @@ These are all the properties and API keys you'll need to set up Squanchy correct
* A signing keystore with the associated password, alias and alias password
* A base URL to use to compose the address of the RESTful endpoints exposed by the backend
* A Fabric API key (you'll obtain it by adding the app to Fabric through the [Android Studio plugin](https://fabric.io/downloads/android-studio))
* A Twitter API key and secret, which you can get by adding the Twitter kit to Fabric (you can add it through the
[Android Studio plugin](https://fabric.io/downloads/android-studio))
* An Algolia project, used to perform search in the app, which you can create on the [Algolia website](https://www.algolia.com)
* A `google-services.json` file that you can obtain from the [Firebase Console](https://console.firebase.google.com/) for your project

## How to set the properties up
@@ -30,7 +29,7 @@ disclosed or added to the repository. In that folder you'll find a `.sample` ver
`.sample` extension (e.g., copy `secrets.properties.sample` renaming it as `secrets.properties`).

### Application properties
This file contains the application package (`applicationId`), and the social query (`socialQuery`) to use for the Twitter timeline in the app.
This file contains the application package (`applicationId`) and the Algolia id (`algoliaId`)

### Release signing configuration
This file will tell Gradle which keystore to use (`storeFile`) and its password (`storePassword`), in order to correctly sign release apks. In additio
@@ -44,9 +43,9 @@ This file contains a bunch of private configuration details that are not needed
* `fabricApiKey` is the API key to use for Fabric (and thus, Crashlytics). To obtain this, enable the app for Fabric from the
[Fabric plugin](https://fabric.io/downloads/android-studio), let it change stuff, get the API key it generates, and put it into the properties
file. Then revert whatever changes the Fabric wizard might have applied to the code
* `twitterApiKey` and `twitterSecret` are used by the Twitter SDK. You can obtain them by enabling the Twitter Kit in Fabric; just click the
corresponding button in the Fabric plugin UI in Android Studio, grab the keys from wherever it adds them, move them to the properties file, and
revert whatever other changes the wizard might have done to the code

* `algoliaApiKey` is the API key to use for Algolia, the framework responsible for the search feature in the app. After creating a project in the
[Algolia website](https://www.algolia.com), you can find it in the "API keys" section of the dashboard

### Google Play Store keys
There is also a `play-store-keys.json` file that you can generate from your Developer Account in the Play Store. In order to do so, please follow

0 comments on commit 0b4ee42

Please sign in to comment.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.