-
Notifications
You must be signed in to change notification settings - Fork 625
Add README files #4857
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add README files #4857
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Firebase Sessions SDK | ||
|
||
The Firebase Sessions SDK is used by Crashlytics and Performance internally to measure sessions. | ||
|
||
## Building | ||
|
||
All Gradle commands should be run from the root of this repository. | ||
|
||
`./gradlew -PprojectsToPublish=":firebase-sessions" publishProjectsToMavenLocal` | ||
|
||
## Running Tests | ||
|
||
Unit tests: | ||
mrober marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
`./gradlew :firebase-sessions:test` | ||
|
||
Integration tests, requiring a running and connected device (emulator or real): | ||
|
||
`./gradlew :firebase-sessions:connectedAndroidTest` | ||
|
||
## Code Formatting | ||
|
||
Format Kotlin code in this SDK in Android Studio using | ||
the [ktfmt plugin](https://plugins.jetbrains.com/plugin/14912-ktfmt) with code style to | ||
**Google (internal)**, or by running: | ||
|
||
`./gradlew :firebase-sessions:ktfmtFormat` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Firebase Sessions Test App | ||
|
||
## Setup | ||
|
||
Download the `google-services.json` file | ||
from [Firebase Console](https://console.firebase.google.com/) (for whatever Firebase project you | ||
have or want to integrate the `test-app`) and store it under the current directory. | ||
|
||
Note: The [Package name](https://firebase.google.com/docs/android/setup#register-app) for your app | ||
created on the Firebase Console (for which the `google-services.json` is downloaded) must match | ||
the [applicationId](https://developer.android.com/studio/build/application-id.html) declared in | ||
the `test-app/test-app.gradle.kts` for the app to link to Firebase. | ||
|
||
## Running | ||
|
||
Run the test app directly from Android Studio by selecting and running | ||
the `firebase-sessions.test-app` run configuration. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.