TikTok-Clone

A beautifully designed replica of the famous and trending TikTok app

Installation

Clone this repository and import into Android Studio

git clone git@github.com:Andre_Max/TikTok-Clone.git

Build variants

Use the Android Studio Build Variants button to choose between production and staging flavors combined with debug and release build types

Generating signed APK

From Android Studio:

Build menu
Generate Signed APK...
Fill in the keystore information (you only need to do this once manually and then let Android Studio remember it)

Before every commit, make sure you run the following bash script:

./codeAnalysis

To test code coverage, run the following bash script:

./coverage

If you have Fastlane installed, you can run the develop lane:

fastlane branch conf:debug

Tech-stack

Tech-stack
- Kotlin - a cross-platform, statically typed, general-purpose programming language with type inference.
- Coroutines - perform background operations.
- Flow - handle the stream of data asynchronously that executes sequentially.
- Hilt - an opinionated dependency injection library for Android.
- Firebase - a Google-backed application development software for user authentication and remote storage.
- Exoplayer - an application level media player for Android.
- Jetpack
  - Room - a persistence library provides an abstraction layer over SQLite.
  - LiveData - is an observable data holder.
  - Lifecycle - perform action when lifecycle state changes.
  - ViewModel - store and manage UI-related data in a lifecycle conscious way.
- Stetho - application debugging tool.
- Timber - a highly extensible android logger.
- Leak Canary - a memory leak detection library for Android.
Architecture
- MVVM - Model View View Model
Tests
- Unit Tests (JUnit) - a simple framework to write repeatable tests.
- MockK - mocking library for Kotlin
- Truth - Fluent Assertion-Library
- Espresso - An Android testing framework for writing concise, beautiful, and reliable Android UI tests.
Gradle
- Gradle Kotlin DSL - For reference purposes, here's an article explaining the migration.
- Plugins
  - Ktlint - creates convenient tasks in your Gradle project that run ktlint checks or do code auto format.
  - Detekt - a static code analysis tool for the Kotlin programming language.
  - Spotless - format java, groovy, markdown and license headers using gradle.
  - jacoco - a Code Coverage Library
CI/CD
- Github Actions
- Fastlane

Dependencies

All the dependencies (external libraries) are defined in the single place - Gradle buildSrc folder. This approach allows to easily manage dependencies and use the same dependency version across all modules.

License

MIT License

Copyright (c) 2021 Andre-max

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

ahelmoselhy / TikTokClone