tydaikho/QuoteUnquote

Quote Unquote - a Quotes Widget

Quote Unquote

---

1. Status

	branch	ci:coverage	codecov	codacy	sonarcloud	codescene	deployment
:app	main
:cloudLib	main
functions	main
:utilsLib	main

• :app codecov available via codecov.sh
• sonarqube available via sonarqube.sh

---

2. High Level Design

2.1. Deployment Diagram

2.2. androidTest ROOM Class Diagram

---

3. Build Instructions

After cloning extract .gpg files = BuildConfig / GitHub Action Secrets values.

3.1. CLI

git clone https://github.com/jameshnsears/QuoteUnquote
cd QuoteUnquote
git submodule update --init --recursive
git submodule foreach git pull origin main
git submodule

3.2. Android Studio Arctic Fox

Android Studio > Get from Version Control
 > https://github.com/jameshnsears/QuoteUnquote
 > Clone

NOTE: import to clone for IDE as submodules maintained

VCS > Git > Branches...
 > Remote Branches > origin/main > Checkout
  > Smart Checkout

git submodule update --remote

git remote add cloudLib https://github.com/jameshnsears/QuoteUnquote.cloudLib
git remote add cloudLib.functions https://github.com/jameshnsears/QuoteUnquote.cloudLib.functions
git remote add utilsLib https://github.com/jameshnsears/QuoteUnquote.utilsLib

Build > Rebuild Project

Choose a Build Variant  
 > run a Run/Debug Configuration

3.3. PyCharm

After a clone...

PyCharm > Open > QuoteUnquote.cloudLib.functions

File > Settings > Project:
 > set Intepreter > New Virtualenv Environment

Virtualenv Terminal > 
 > python -m pip install -r requirements-test.txt
 > python -m pip install -r src/requirements.txt

run a Run/Debug Configuration 
 > setting Python Intepreter to Virtualenv Environment