Update README.md #39
Update README.md #39
Conversation
|
Not sure why you created a new PR for this, but let's continue here since this has the latest changes. |
There was a problem hiding this comment.
There is some information missing.. when you clone the project, you need to make some configurations before being able to run it.. those are:
- Downliading google-services.json and adding it to the project.. this might require to ask the administrators to give access to the firebase project.
- Creating a property in the user's local
gradle.propertiesfile
For more on that, please speak with Hunter.
Also, we might not need a lot of this information.. for example, to download Android studio, you could just leave the link here and let the user follow the link's instructions.
| The following link shows in more detail the steps to follow: | ||
| [https://firebase.google.com/docs/android/setup#next_steps] | ||
|
|
||
|
|
There was a problem hiding this comment.
Add a section to talk about Gradle global variables we need. We currently use User Password and BaseUrl.
There was a problem hiding this comment.
Remember that someone following this document should be able to run the app with no problem; this means that we need to provide the necessary information (no more, no less) that a collaborator needs. You can assume that things like what is Kotlin, what is Android, how to install Android Studio, and all that stuff will be found on the internet; your job here is to provide the missing pieces like:
- Asking for the
google-services.jsonfile - Adding global variables to
gradle.propertiesand asking mentors for the correct values - Who to ask for an account to be added to a repository
- Etc.
You can always reach me through Slack to ask me questions about this.
| * It is oriented to API level 16 (Jelly Bean) or higher. | ||
| * Use Gradle 4.1 or a more recent version. |
There was a problem hiding this comment.
No need to clarify this, this is already on the code
| * Make sure the config file is not appended with additional characters, like (2). | ||
| * Move your config file into the module (app-level) directory of your app. | ||
|
|
||
| 5. To enable Firebase products in your app, add the [google-services plugin](https://developers.google.com/android/guides/google-services-plugin) to your Gradle files. |
There was a problem hiding this comment.
This step is not necessary here, this is already done in the code
There was a problem hiding this comment.
You can get rid of steps 5 and 6
| * If you added Analytics, run your app to send verification to Firebase that you've successfully integrated Firebase. Otherwise, you can skip the verification step. | ||
| * Your device logs will display the Firebase verification that initialization is complete. If you ran your app on an emulator that has network access, the Firebase console notifies you that your app connection is complete. | ||
|
|
||
| 7. Gradle properties |
There was a problem hiding this comment.
We need to use machine level gradle.properties so the secrets are not uploaded to git, please change this section to reflect that. Check this out:
https://medium.com/code-better/hiding-api-keys-from-your-android-repository-b23f5598b906
There was a problem hiding this comment.
Also, you have to mention the specific keys that we need to use, those are User Password and BaseUrl. Remember that someone following this document should be able to run the app with no problem, this means that we need to provide the necessary information (no more, no less) that a collaborator needs.
No description provided.