add/retactor : mockups , some bug fixes and refactor.

Author: sarafanshul

.github/workflows/android-build-debug.yml

@@ -20,9 +20,24 @@ jobs:
           cache: gradle
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
+      - name: Config Luffy API
+        env:
+          Y: ${{secrets.API_BASE_URL}}
+        run: echo -e "API_BASE_URL=$Y \n" >> ./local.properties
+      - name: Config Avatar API
+        env:
+          X : ${{secrets.AVATAR_API}}
+        run: echo -e "AVATAR_API=$X \n" >> ./local.properties
+      - name: Config RabbitMQ
+        env:
+          A : ${{secrets.RABBITMQ_HOST}}
+          B : ${{secrets.RABBITMQ_PORT}}
+          C : ${{secrets.RABBIT_USER_NAME}}
+          D : ${{secrets.RABBIT_USER_PASSWORD}}
+        run: echo -e "RABBITMQ_HOST=$A\nRABBITMQ_PORT=$B\nRABBIT_USER_NAME=$C\nRABBIT_USER_PASSWORD=$D" >> ./local.properties
       - name: Build App
         run: ./gradlew assembleDebug --stacktrace
       - uses: actions/upload-artifact@v2
         with:
           name: zoro-build-debug
-          path: app/build/outputs/apk/debug/app-debug.apk
+          path: app/build/outputs/apk/debug/app-debug.apk

.github/workflows/android-lint.yml

@@ -20,9 +20,24 @@ jobs:
           cache: gradle
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
+      - name: Config Luffy API
+        env:
+          Y: ${{secrets.API_BASE_URL}}
+        run: echo -e "API_BASE_URL=$Y \n" >> ./local.properties
+      - name: Config Avatar API
+        env:
+          X : ${{secrets.AVATAR_API}}
+        run: echo -e "AVATAR_API=$X \n" >> ./local.properties
+      - name: Config RabbitMQ
+        env:
+          A : ${{secrets.RABBITMQ_HOST}}
+          B : ${{secrets.RABBITMQ_PORT}}
+          C : ${{secrets.RABBIT_USER_NAME}}
+          D : ${{secrets.RABBIT_USER_PASSWORD}}
+        run: echo -e "RABBITMQ_HOST=$A\nRABBITMQ_PORT=$B\nRABBIT_USER_NAME=$C\nRABBIT_USER_PASSWORD=$D" >> ./local.properties
       - name: Lint Debug
         run: ./gradlew lint
       - uses: actions/upload-artifact@v2
         with:
           name: zoro-lint-report
-          path: app/build/reports/lint-results-debug.html
+          path: app/build/reports/lint-results-debug.html

.github/workflows/android-tests.yml

@@ -14,9 +14,21 @@ jobs:
         run: chmod +x gradlew
       - name: Decode BASEURL
         run: echo API_BASE_URL=TEST > ./local.properties
-#        env:
-#          API_BASE_URL: ${{ secrets.API_BASE_URL }}
-#        run: echo API_BASE_URL=$API_BASE_URL > ./local.properties
+      - name: Config Luffy API
+        env:
+          Y: ${{secrets.API_BASE_URL}}
+        run: echo -e "API_BASE_URL=$Y \n" >> ./local.properties
+      - name: Config Avatar API
+        env:
+          X : ${{secrets.AVATAR_API}}
+        run: echo -e "AVATAR_API=$X \n" >> ./local.properties
+      - name: Config RabbitMQ
+        env:
+          A : ${{secrets.RABBITMQ_HOST}}
+          B : ${{secrets.RABBITMQ_PORT}}
+          C : ${{secrets.RABBIT_USER_NAME}}
+          D : ${{secrets.RABBIT_USER_PASSWORD}}
+        run: echo -e "RABBITMQ_HOST=$A\nRABBITMQ_PORT=$B\nRABBIT_USER_NAME=$C\nRABBIT_USER_PASSWORD=$D" >> ./local.properties
       - name: Unit tests
         run: ./gradlew test --stacktrace
 
@@ -28,9 +40,21 @@ jobs:
         run: chmod +x gradlew
       - name: Decode BASEURL
         run: echo API_BASE_URL=TEST > ./local.properties
-#        env:
-#          API_BASE_URL: ${{ secrets.API_BASE_URL }}
-#        run: echo API_BASE_URL=$API_BASE_URL > ./local.properties
+      - name: Config Luffy API
+        env:
+          Y: ${{secrets.API_BASE_URL}}
+        run: echo -e "API_BASE_URL=$Y \n" >> ./local.properties
+      - name: Config Avatar API
+        env:
+          X : ${{secrets.AVATAR_API}}
+        run: echo -e "AVATAR_API=$X \n" >> ./local.properties
+      - name: Config RabbitMQ
+        env:
+          A : ${{secrets.RABBITMQ_HOST}}
+          B : ${{secrets.RABBITMQ_PORT}}
+          C : ${{secrets.RABBIT_USER_NAME}}
+          D : ${{secrets.RABBIT_USER_PASSWORD}}
+        run: echo -e "RABBITMQ_HOST=$A\nRABBITMQ_PORT=$B\nRABBIT_USER_NAME=$C\nRABBIT_USER_PASSWORD=$D" >> ./local.properties
       - name: Setup Java
         uses: actions/setup-java@v2
         with:

.github/workflows/detekt-analysis.yml

@@ -32,7 +32,21 @@ jobs:
         run: chmod +x gradlew
       - name: Run Detekt
         run: ./gradlew detekt
-
+      - name: Config Luffy API
+        env:
+          Y: ${{secrets.API_BASE_URL}}
+        run: echo -e "API_BASE_URL=$Y \n" >> ./local.properties
+      - name: Config Avatar API
+        env:
+          X : ${{secrets.AVATAR_API}}
+        run: echo -e "AVATAR_API=$X \n" >> ./local.properties
+      - name: Config RabbitMQ
+        env:
+          A : ${{secrets.RABBITMQ_HOST}}
+          B : ${{secrets.RABBITMQ_PORT}}
+          C : ${{secrets.RABBIT_USER_NAME}}
+          D : ${{secrets.RABBIT_USER_PASSWORD}}
+        run: echo -e "RABBITMQ_HOST=$A\nRABBITMQ_PORT=$B\nRABBIT_USER_NAME=$C\nRABBIT_USER_PASSWORD=$D" >> ./local.properties
       # Make sure we always run this upload task,
       # because the previous step may fail if there are findings.
       - uses: github/codeql-action/upload-sarif@v1

.idea/copyright/anshul.xml

@@ -1,12 +1,55 @@
 # Zoro
 
-### How to setup :
-- Backend 
+<p align="center">
+  <a href="https://devlibrary.withgoogle.com/products/android/repos/skydoves-pokedex"><img alt="Google" src="https://skydoves.github.io/badges/google-devlib.svg"/></a><br>
+  <a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
+  <a href="https://android-arsenal.com/api?level=27"><img alt="API" src="https://img.shields.io/badge/API-27%2B-brightgreen.svg?style=flat"/></a>
+  <a href="https://github.com/sarafanshul/Zoro/actions"><img alt="Build Status" src="
+https://github.com/sarafanshul/zoro/actions/workflows/android-release-artifact.yml/badge.svg"/></a> 
+</p>
+
+<p align="center">  
+Zoro is an secure chat application based on <a href="https://www.amqp.org/">AMQP</a> for pub-sub service ,<a href="https://github.com/sarafanshul/luffy/">Luffy</a> for secure backend and utilizes MVVM architecture.<br>This project uses Hilt of implementing dependency injection.<br>
+Also fetching data from the network and integrating persisted data in the database via repository pattern.
+</p>
+<br>
+
+<p align="center">
+<img src="./assets/mockups/merger_mockup.png"/>
+</p>
+
+## Download
+Go to the [Releases](https://github.com/sarafanshul/Zoro/releases) to download the latest package.
+
+
+<img src="./assets/mockups/Screenshot_1641750816_framed.png" align="right" width="32%"/>
+
+## Tech stack & Open-source libraries
+- Minimum SDK level 29
+- [Kotlin](https://kotlinlang.org/) based, [Coroutines](https://github.com/Kotlin/kotlinx.coroutines) + [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/) for asynchronous.
+- [Hilt](https://dagger.dev/hilt/) for dependency injection.
+- JetPack
+	- Lifecycle - dispose of observing data when lifecycle state changes.
+	- ViewModel - UI related data holder, lifecycle aware.
+	- Room Persistence - construct a database using the abstract layer.
+- Architecture
+	- MVVM Architecture (View - DataBinding - ViewModel - Model)
+	- [Datastore](https://developer.android.com/topic/libraries/architecture/datastore) - Uses Kotlin coroutines and Flow to store data asynchronously, consistently, and transactionally..
+	- Repository pattern
+- [Retrofit2 & OkHttp3](https://github.com/square/retrofit) - construct the REST APIs and paging network data.
+- [Glide](https://github.com/bumptech/glide), [GlidePalette](https://github.com/florent37/GlidePalette) - loading images.
+- [Timber](https://github.com/JakeWharton/timber) - logging.
+- [Material-Components](https://github.com/material-components/material-components-android) - Material design components like ripple animation, cardView.
+
+UI is utilising a dual-theme approach, allowing users to choose from light or dark theme. Components from Material Design library (MaterialCardview, MaterialToolbar, BottomNavigationView etc.) have been used due to their ability to switch between colour Primary and colour Surface. Detail Fragments are designed in a way that allows the user to drag and move contents - this behaviour is implemented by using MotionLayout. MaterialContainerTransform (shared element transitions), MaterialFadeThrough and MaterialElevationScale from Material Design library have been used to animate transitions between list and detail fragments.
+
+## How to setup :
+- Backend
 	- Clone [Luffy](https://github.com/sarafanshul/Luffy) for backend (not necessary if using compose).
-	- If not cloned , copy the `compose file` from [docker/anshulsaraf/luffy](https://hub.docker.com/repository/docker/anshulsaraf/luffy) into a folder 
+	- If not cloned , copy the `compose file` from [docker/anshulsaraf/luffy](https://hub.docker.com/repository/docker/anshulsaraf/luffy) into a folder
 	- Make sure [Docker](https://www.docker.com/) is running .
-	- `cd` inside the folder where `compose file` is saved and run `docker compose up` 
-	- Now your backend should be up 
+	- `cd` inside the folder where `compose file` is saved and run `docker compose up`
+	- Now your backend should be up
 - Frontend
 	- Inside `NetworkingConstants.kt` configure your backend constants
 	- Replace the keystore  from `app/keystore/ZoroKeyStore.jks`with your signed one.
@@ -15,3 +58,35 @@
 - Android Studio specific
 	- Invalidate Cache (just to be safe)
 	- Build and add magic
+
+## MAD Score
+![summary](./assets/mad/summary.png)
+![kotlin](./assets/mad/kotlin.png)
+
+## Architecture
+NarutoDex is based on MVVM architecture and a repository pattern.
+
+![architecture](/assets/architecture/mvvm.png)
+
+## Authors
+[Anshul](https://github.com/sarafanshul)
+
+## Find this repository useful? :heart:
+__[follow](https://github.com/sarafanshul)__ me for my next creations! 🤩
+
+# License
+```xml
+Designed and developed by 2020 sarafanshul (Anshul Saraf)
+
+		Licensed under the Apache License, Version 2.0 (the "License");
+		you may not use this file except in compliance with the License.
+		You may obtain a copy of the License at
+
+		http://www.apache.org/licenses/LICENSE-2.0
+
+		Unless required by applicable law or agreed to in writing, software
+		distributed under the License is distributed on an "AS IS" BASIS,
+		WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+		See the License for the specific language governing permissions and
+		limitations under the License.
+```

.idea/copyright/profiles_settings.xml

@@ -1,3 +1,7 @@
+/*
+ * Copyright (c) 2022. Anshul Saraf
+ */
+
 apply plugin: 'com.android.application'
 
 apply plugin: 'kotlin-android'

README.md

@@ -1,3 +1,7 @@
+/*
+ * Copyright (c) 2022. Anshul Saraf
+ */
+
 package com.projectdelta.zoro
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
@@ -19,4 +23,4 @@ class ExampleInstrumentedTest {
         val appContext = InstrumentationRegistry.getInstrumentation().targetContext
         assertEquals("com.projectdelta.zoro", appContext.packageName)
     }
-}
+}

app/build.gradle

@@ -50,4 +50,4 @@
 
     </application>
 
-</manifest>
+</manifest>