CSDK-1413: Android Starter Kit (#1)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: BUG
+labels: bug
+assignees: kompfner
+---
+
+<!-- If you're experiencing a bug while on a Daily call, before filing a bug report, please try these troubleshooting steps: https://help.daily.co/en/articles/2303117-top-troubleshooting-tips -->
+
+# Expected behavior
+
+<!-- Please share a clear and concise description of what you expected to happen. -->
+
+# Describe the bug (unexpected behavior)
+
+<!-- A clear and concise description of what the bug is. -->
+
+# Steps to reproduce
+
+<!-- 1. Go to '...' -->
+<!-- 2. Click on '....' -->
+<!-- 3. Scroll down to '....' -->
+<!-- 4. See error -->
+
+# Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+# System information
+
+<!-- Please tell us as much as you can about your setup. Because of how video calls can vary across browsers and devices, this information will help us troubleshoot your issue faster. -->
+
+- Device:
+- OS, version:
+- daily-client-android version:
+- (if applicable) Browser, version:
+
+# Additional context
+
+<!-- Add any other context about the problem or helpful links here. -->

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: Build
+
+on:
+    push:
+    pull_request:
+    schedule:
+        -   cron: '00 2 * * 1'
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v2
+
+            -   name: Debug build
+                run: ./gradlew assembleDebug
+
+            -   name: Upload built APK
+                uses: actions/upload-artifact@v2
+                with:
+                    name: demo-debug.apk
+                    path: starter-kit/build/outputs/apk/debug/starter-kit-debug.apk

CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributing
+
+Thank you for looking into contributing to `daily-demos`! We want this repo to help people experiment with different Daily projects more quickly. We especially welcome any contributions that help us make existing demos easier to understand or that improve demos' instructions and descriptions, and we're especially excited about any new demos that highlight unique ways to use the [Daily API](https://docs.daily.co/reference).
+
+**Before contributing:**
+
+- [Run daily-demos locally](#run-daily-demos-locally)
+- [Read our code of conduct](#read-our-code-of-conduct)
+
+**How to contribute:**
+
+- [Open or claim an issue](#open-or-claim-an-issue)
+- [Open a pull request](#open-a-pull-request)
+- [Contribute a new demo project](#contribute-a-new-demo-project)
+
+## Before contributing
+
+### Try to run the demo locally
+
+Please follow the instructions in `README.md`.
+
+### Read our code of conduct
+
+We use the [Contributor Covenant](https://www.contributor-covenant.org/) for our Code of Conduct. Before contributing, [please read it](CODE_OF_CONDUCT.md).
+
+## How to contribute
+
+### Open or claim an issue
+
+#### Open an issue
+
+Today we work off two main issue templates: _bug reports_ and _demo/feature requests_.
+
+_Bug reports_
+
+Before creating a new bug report, please do two things:
+
+1. If you want to report a bug you experienced while on a Daily call, try out these [troubleshooting tips](https://help.daily.co/en/articles/2303117-top-troubleshooting-tips) to see if that takes care of the bug.
+2. If you're still seeing the error, check to see if somebody else has [already filed the issue](https://github.com/daily-demos/daily-android-demo/issues) before creating a new one.
+
+If you've done those two things and need to create an issue, we'll ask you to tell us:
+
+- What you expected to happen
+- What actually happened
+- Steps to reproduce the error
+- Screenshots that illustrate where and what we should be looking for when we reproduce
+- System information, like your device, OS, daily-client-android library version, and if applicable, browser
+- Any additional context that you think could help us work through this
+
+_Demo/feature requests_
+
+We're always happy to hear about new ways you'd like to use Daily. If you'd like a demo that we don't have yet, we'll ask you to let us know:
+
+- If the demo will help you solve a particular problem
+- Alternative solutions you've considered
+- Any additional context that might help us understand this ask
+
+#### Claim an issue
+
+Any issues labeled `good-first-issue` are up for grabs. If you'd like to tackle an existing issue, feel free to assign yourself, and please leave a comment letting everyone know that you're on it.
+
+### Open a pull request
+
+- If it's been a minute or if you haven't yet cloned, forked, or branched a repository, GitHub has some [docs to help](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests).
+- When creating commit messages and pull request titles, please follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
+
+### Contribute a new demo project
+
+If you've built a project on Daily that you want to share with other developers, we'd be more than happy to help spread the word.
+
+To add a new demo project:
+
+Open a PR in [awesome-daily](#) and add a link to your project.

LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2023, daily
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1 +1,40 @@
-# daily-android-starter-kit
+# A video chat app using Daily's Client SDK for Android
+
+This demo showcases a basic video chat app that uses Daily's native [Android SDK](https://docs.daily.co/guides/products/mobile#introducing-dailys-native-mobile-libraries-beta) mobile library.
+
+## Prerequisites
+
+- [Sign up for a Daily account](https://dashboard.daily.co/signup).
+- [Create a Daily room](https://help.daily.co/en/articles/4202139-creating-and-viewing-rooms), and then enter that URL into the demo. Manual room creation is only recommended for testing purposes -- in a production app we recommend creating Daily rooms [programmatically through our REST API](https://docs.daily.co/reference/rest-api/rooms/create-room).
+- Install [Android Studio](https://developer.android.com/studio) and its prerequisites. The [install](https://developer.android.com/studio/install) and [run](https://developer.android.com/studio/run) instructions ought to cover what you need.
+
+## How the demo works
+
+In the demo app, a user must enter a URL for a [Daily room](https://docs.daily.co/reference#rooms), then press Join. The app will find the meeting room and join the call.
+
+Most of the call-related logic in the app can be found in `DemoCallService`. This initializes a Daily `CallClient` instance, which is responsible for:
+
+* Establishing a connection to the meeting room
+* Keeping track of other participants, including their audio and video tracks
+* Managing call settings, such as camera/microphone configuration
+* Performing actions such as sending custom messages, or leaving the call
+
+The call client is destroyed when the application exits.
+
+When testing or running this demo, you can use a room you've manually created for calls. A production application should use the [Daily REST API](https://docs.daily.co/reference/rest-api) to create rooms on the fly for your users, which necessitates the use of a sensitive Daily API key. For security reasons, you likely don't want to embed this key in a production app. We recommend running a web server and keeping sensitive things like API keys there instead.
+
+Please note this project is designed to work with rooms that have [privacy](https://www.daily.co/blog/intro-to-room-access-control/) set to `public`. If you are hardcoding a room URL, please bear in mind that token creation, pre-authorization, and knock-for-access have not been implemented here, meaning you may not be able to join non-public meeting rooms using this demo for now.
+
+## Running locally
+
+1. Clone this repository locally, i.e.: `git clone [email protected]:daily-demos/daily-android-starter-kit.git`
+2. Open the directory in Android Studio.
+3. Install dependencies by syncing your Android Studio project's gradle files using the Android Studio UI popups.
+4. Build the project.
+5. Run the project, either on a simulator (which will not have webcam access, but which can send an image in place of a real camera stream), or on a connected Android device.
+6. Connect to the room URL you are testing.
+7. To view a remote participant, connect again either in another simulator, on another device, or using a web browser. Careful of mic feedback! You might want to mute one or both sides' audio if they're near each other.
+
+## Contributing and feedback
+
+Let us know how experimenting with this demo goes! Feel free to [open an issue](https://github.com/daily-demos/daily-android-starter-kit/issues), or reach us any time at `[email protected]`.

build.gradle

@@ -0,0 +1,19 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+buildscript {
+    ext.kotlin_version = '1.6.21'
+
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:7.4.0'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        // NOTE: Do not place your application dependencies here; they belong
+        // in the individual module build.gradle files
+    }
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}

gradle.properties

@@ -0,0 +1,23 @@
+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app"s APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true
+# Kotlin code style for this project: "official" or "obsolete":
+kotlin.code.style=official
+# Enables namespacing of each library's R class so that its R class includes only the
+# resources declared in the library itself and none from the library's dependencies,
+# thereby reducing the size of the R class for that library
+android.nonTransitiveRClass=true

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists