QuoteUnquote Save

A Quotes / Quotations / Affirmations App Widget.

Project README

Quote Unquote

Get it on Google Play Get it on F-Droid


1. Status

ci codecov codacy sonarcloud codescene deployment
:app codecov.yml codecov.yml Codacy Badge CodeScene general
:cloudLib coverage codecov Codacy Badge Quality Gate Status
functions coverage codecov Codacy Badge Quality Gate Status CodeScene general deploy-gcp
:utilsLib coverage codecov Codacy Badge Quality Gate Status

1.1. codecov.yml

test androidTest cli (API 30) codecov
coverage-test coverage-androidTest post-push-codecov.sh codecov

2. High Level Design

2.1. Deployment Diagram

Deployment Diagram

2.2. androidTest ROOM Class Diagram

androidTest ROOM Class Diagram


3. Build Instructions

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

The app can be built on Windows 11 but the ./bin folder contains bash scripts (that work with git bash; some require gh cli).

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

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 origin/cloudLib https://github.com/jameshnsears/QuoteUnquote.cloudLib
git remote add origin/cloudLib.functions https://github.com/jameshnsears/QuoteUnquote.cloudLib.functions
git remote add origin/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
Open Source Agenda is not affiliated with "QuoteUnquote" Project. README Source: jameshnsears/QuoteUnquote
Stars
49
Open Issues
10
Last Commit
6 days ago
License

Open Source Agenda Badge

Open Source Agenda Rating