Skip to content
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

Add README files #4857

Merged
merged 4 commits into from
Apr 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions firebase-sessions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Firebase Sessions SDK

mrober marked this conversation as resolved.
Show resolved Hide resolved
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`
17 changes: 17 additions & 0 deletions firebase-sessions/test-app/README.md
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.