Merge pull request #28 from rodekruis/develop

Develop
rodekruis · Dec 15, 2024 · 912fbc5 · 912fbc5
2 parents 6d43acd + 22622bd
commit 912fbc5
Show file tree

Hide file tree

Showing 318 changed files with 157,770 additions and 59 deletions.
diff --git a/.github/workflows/azure-static-web-apps-black-stone-02fb10f03.yml b/.github/workflows/azure-static-web-apps-black-stone-02fb10f03.yml
@@ -0,0 +1,49 @@
+name: Azure Static Web Apps CI/CD
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+      - feature/*
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    branches:
+      - main
+      - develop
+
+jobs:
+  build_and_deploy_job:
+    if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
+    runs-on: ubuntu-latest
+    name: Build and Deploy Job
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+          lfs: false
+      - name: Build And Deploy
+        id: builddeploy
+        uses: Azure/static-web-apps-deploy@v1
+        with:
+          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_BLACK_STONE_02FB10F03 }}
+          repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
+          action: "upload"
+          ###### Repository/Build Configurations - These values can be configured to match your app requirements. ######
+          # For more information regarding Static Web App workflow configurations, please visit: https://aka.ms/swaworkflowconfig
+          app_location: "./PWA/public/" # App source code path
+          api_location: "" # Api source code path - optional
+          output_location: "." # Built app content directory - optional
+          ###### End of Repository/Build Configurations ######
+
+  close_pull_request_job:
+    if: github.event_name == 'pull_request' && github.event.action == 'closed'
+    runs-on: ubuntu-latest
+    name: Close Pull Request Job
+    steps:
+      - name: Close Pull Request
+        id: closepullrequest
+        uses: Azure/static-web-apps-deploy@v1
+        with:
+          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_BLACK_STONE_02FB10F03 }}
+          action: "close"
diff --git a/.gitignore b/.gitignore
@@ -10,7 +10,6 @@ __pycache__/
 *.xlsx
 *.csv
 *.pdf
-*.json
 
 # C extensions
 *.so

diff --git a/LICENSE → POC/LICENSE b/LICENSE → POC/LICENSE
diff --git a/POC/README.md b/POC/README.md
@@ -0,0 +1,53 @@
+# ReliefBox
+
+A simple web app for relief.
+https://relief-system-webapp.azurewebsites.net/
+
+## Description
+
+Synopsis: a [flask python app](https://flask.palletsprojects.com/en/2.0.x/).
+
+Workflow: upload data of beneficiaries, start distribution, check if beneficiaries are eligible, download report.
+
+## Setup
+
+### on Azure
+1. [Deploy the web app to Azure App Service](https://learn.microsoft.com/en-us/azure/app-service/quickstart-python)
+3. Add necessary keys as environmental variables. From Azure Portal, App Service > Configuration > New application setting
+```
+SQL_USERNAME=...
+SQL_PASSWORD=...
+COSMOS_KEY=...
+MODE=online
+```
+
+### build as standalone app
+```
+pyinstaller --onefile --add-data 'templates;templates' --add-data 'static;static' --add-data 'data;data' --add-data './*.py;.' app.py
+```
+
+### on Raspberry Pi 4
+1. [Create wireless access point](https://raspberrypi-guide.github.io/networking/create-wireless-access-point#start-up-the-wireless-access-point)
+2. Clone this repository
+```
+$ git clone https://github.com/rodekruis/relief-app.git
+$ cd relief-app
+```
+3. Set offline mode in .env
+```
+$ echo -n "MODE=offline" > .env
+```
+4. Install app dependencies and run it
+```
+$ sudo apt-get update
+$ sudo apt-get install libatlas-base-dev libcblas-dev g++ unixodbc-dev
+$ pip install -r requirements.txt
+$ python app.py
+```
+Debug connection issues (to be improved):
+```
+$ sudo systemctl stop hostapd
+$ sudo systemctl unmask hostapd
+$ sudo systemctl enable hostapd
+$ sudo systemctl start hostapd
+```
diff --git a/app.py → POC/app.py b/app.py → POC/app.py
diff --git a/data/.gitignore → POC/data/.gitignore b/data/.gitignore → POC/data/.gitignore
diff --git a/POC/data/data_template.xlsx b/POC/data/data_template.xlsx
diff --git a/docs/Makefile → POC/docs/Makefile b/docs/Makefile → POC/docs/Makefile
diff --git a/docs/html/_static/ReliefBox.PNG → POC/docs/html/_static/ReliefBox.PNG b/docs/html/_static/ReliefBox.PNG → POC/docs/html/_static/ReliefBox.PNG
diff --git a/docs/make.bat → POC/docs/make.bat b/docs/make.bat → POC/docs/make.bat
diff --git a/docs/source/ReliefBox.PNG → POC/docs/source/ReliefBox.PNG b/docs/source/ReliefBox.PNG → POC/docs/source/ReliefBox.PNG
diff --git a/docs/source/conf.py → POC/docs/source/conf.py b/docs/source/conf.py → POC/docs/source/conf.py
diff --git a/docs/source/index.rst → POC/docs/source/index.rst b/docs/source/index.rst → POC/docs/source/index.rst
diff --git a/docs/source/installation.rst → POC/docs/source/installation.rst b/docs/source/installation.rst → POC/docs/source/installation.rst
diff --git a/docs/source/requirements.txt → POC/docs/source/requirements.txt b/docs/source/requirements.txt → POC/docs/source/requirements.txt
diff --git a/docs/source/usage.rst → POC/docs/source/usage.rst b/docs/source/usage.rst → POC/docs/source/usage.rst
diff --git a/main.py → POC/main.py b/main.py → POC/main.py
diff --git a/requirements.txt → POC/requirements.txt b/requirements.txt → POC/requirements.txt
diff --git a/templates/base.html → POC/templates/base.html b/templates/base.html → POC/templates/base.html
diff --git a/templates/delete_distrib_confirm.html → POC/templates/delete_distrib_confirm.html b/templates/delete_distrib_confirm.html → POC/templates/delete_distrib_confirm.html
diff --git a/templates/duplicate_error.html → POC/templates/duplicate_error.html b/templates/duplicate_error.html → POC/templates/duplicate_error.html
diff --git a/templates/entry.html → POC/templates/entry.html b/templates/entry.html → POC/templates/entry.html
diff --git a/templates/entry_not_found.html → POC/templates/entry_not_found.html b/templates/entry_not_found.html → POC/templates/entry_not_found.html
diff --git a/templates/index.html → POC/templates/index.html b/templates/index.html → POC/templates/index.html
diff --git a/templates/index_distrib.html → POC/templates/index_distrib.html b/templates/index_distrib.html → POC/templates/index_distrib.html
diff --git a/templates/input.html → POC/templates/input.html b/templates/input.html → POC/templates/input.html
diff --git a/templates/input_video.html → POC/templates/input_video.html b/templates/input_video.html → POC/templates/input_video.html
@@ -24,7 +24,7 @@
 <label hidden>Result:</label>
 <pre hidden><code id="result"></code></pre>
 
-<script type="text/javascript" src="https://unpkg.com/@zxing/library@latest/umd/index.min.js"></script>
+<script type="text/javascript" src=/ExternalLibraries/zxing.js"></script>
 <script type="text/javascript">
     window.addEventListener('load', function () {
       let selectedDeviceId;

diff --git a/templates/list_distrib.html → POC/templates/list_distrib.html b/templates/list_distrib.html → POC/templates/list_distrib.html
diff --git a/templates/list_distrib_delete.html → POC/templates/list_distrib_delete.html b/templates/list_distrib_delete.html → POC/templates/list_distrib_delete.html
diff --git a/templates/login.html → POC/templates/login.html b/templates/login.html → POC/templates/login.html
diff --git a/templates/name_distrib.html → POC/templates/name_distrib.html b/templates/name_distrib.html → POC/templates/name_distrib.html
diff --git a/templates/no_data.html → POC/templates/no_data.html b/templates/no_data.html → POC/templates/no_data.html
diff --git a/templates/no_distrib.html → POC/templates/no_distrib.html b/templates/no_distrib.html → POC/templates/no_distrib.html
diff --git a/templates/profile.html → POC/templates/profile.html b/templates/profile.html → POC/templates/profile.html
diff --git a/templates/signup.html → POC/templates/signup.html b/templates/signup.html → POC/templates/signup.html
diff --git a/templates/test_login.html → POC/templates/test_login.html b/templates/test_login.html → POC/templates/test_login.html
diff --git a/templates/upload_data.html → POC/templates/upload_data.html b/templates/upload_data.html → POC/templates/upload_data.html
diff --git a/templates/upload_error.html → POC/templates/upload_error.html b/templates/upload_error.html → POC/templates/upload_error.html
diff --git a/templates/view_data.html → POC/templates/view_data.html b/templates/view_data.html → POC/templates/view_data.html
diff --git a/utils.py → POC/utils.py b/utils.py → POC/utils.py
diff --git a/PWA/.babelrc b/PWA/.babelrc
@@ -0,0 +1,4 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-typescript"],
+  "plugins": []
+}
diff --git a/PWA/.gitignore b/PWA/.gitignore
@@ -0,0 +1,2 @@
+.idea
+node_modules
diff --git a/PWA/README.md b/PWA/README.md
@@ -0,0 +1,254 @@
+# Reliefbox Progressive web app
+Offline version of reliefbox, built using typescript and relying heavily on service workers and IDB database. Upon installation the app works 100% offline, from this point on no backend calls are done anymore.
+
+### During development
+
+Make sure all terninal tabs are in the PWA directory, then run:
+`npm start` to launch the local server
+`tsc --watch` to make sure typescript files get compiled as you code
+`npm run test -- --watch` to make sure run as you code
+
+* All new files need to be added to `CachePathFileService`
+* All new `FetchEventHandler` classes need to be added to `FetchEventHandlers`
+
+#### Versioning
+The apps version is stored in package.json and index.html current way to update this is by simply find replacing the previous version with the new one, making sure only the two files above are effected.
+
+### Architercture / dataflow
+
+1. HTTP requests are handled by serviceworker
+2. Service worker dispatches request to `FetchEventHandlers`
+3. `FetchEventHandlers` chooses which `FetchEventHander` should handle the request
+4. `FetchEventHandler` handles the request and serves a new page using `ResponseTools` and using a service if there's been a need for shared or separated logic.
+5. `ResponseTools` leverages the mustache templating system to render pages with the least amount of redundancy
+
+#### Special note about templating
+All pages exept index.html are rendered using template.html. The reason this isn't done for index.html is that the templating system is part of what's handled by the serviceworker, which isn't used yet when loading this first page. Because of this, there's some overlap between index.html and template.html
+
+### IDB Database schema
+
+* Beneficiary
+    * Contains all the info of a beneficary
+      * As provided by user from spreadsheet
+    * Contains the info regarding the receival of goods
+    * Containtains the info to which distribution the beneficiary belongs
+* Distribution
+    * Contains all the info of a distribution
+
+### Third party code used
+* [SheetJS](https://sheetjs.com) (PWA/public/ExternalLibraries/xlsx.full.min.js)
+  * For handling spreadsheat files
+* [Mustache](https://github.com/janl/mustache.js/) (PWA/public/ExternalLibraries/mustache.js)
+    * For html templating
+* [Zxing](https://github.com/zxing-js/library) (PWA/public/ExternalLibraries/zxing.js)
+  * For barcode scanning
+* [Bulma.io](https://bulma.io) (PWA/public/ExternalLibraries/bulma.css)
+  * For page styling styling
+
+### Deployment
+* Compiled code is found in public folder
+  * As configured in PWA/tsconfig.json
+* Github actions is used for deployment of that folder
+  * on push as configured in .github/workflows/azure-static-web-apps-black-stone-02fb10f03.yml
+  * app will be deployed to reliefbox.510.global
+
+
+### Test scripts
+
+Codes in template:
+1 Aric Norwood
+2 Lira Calloway
+3 Daven Morrell
+
+Test devices
+* iPhone 15
+  * iOS 18.1.1
+* Alcatel 1B
+  * Android (Alcatel UI) v9L3D(11-14)
+* Huawei P30 (Serverstack)
+  * Android
+
+Test result legend
+✅ Working as intended on tested device
+🟠 Not working as intended, with workaround / non blocking
+⛔️ Not working on tested device, no workaround
+
+Installing
+  * App can be installed and launched from homescreen
+    ✅ iPhone 15 (0.24.4)
+    ✅ Huawei P30 (0.26.0)
+    🟠 Alcatel 1B (0.24.4)
+      Add to homepage stopped working on this device. It says open reliefbox instead.
+      Currently best known workaround: launching the app from the app launcher. Since this doesn't seem to happen on other
+      android devices, it may be device specific thing, where PWA data isn't removed properly.
+
+Features & verifications:
+* Creating a distribution
+  * Verify that:
+    * Distribution with same name can't be added twice
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+    * Distribution can't have date in the past
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+    * All needed fields need to be entered (Donor and items distributied are optional)
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+* Listing a distribution
+  * Verify that:
+    * Distribution name is shown
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+    * Distribution data is shown (location and date)
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+    * When no beneficary data is added yet:
+      * No beneficiary data found message is shown
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    * When beneficiary data is added
+      * It shows the amount of served beneficaries
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    * Beneficiary data can be addded
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+    * Distribution can be started / resumed
+      ✅ iPhone 15 (0.24.4)
+    * Missing beneficiaries can be checked
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+        Results in site can't be reached page
+    * Beneficiary can be downloaded
+      🟠 iPhone 15 (0.24.4)
+          Dialog can't be dismissed [#24](https://github.com/rodekruis/reliefbox/issues/24)
+      ✅ Alcatel 1B (0.24.4)
+* Adding beneficary data to a distribution
+  * Verify that:
+    * When adding a non supported file, a spreadsheat without a "code" column or a spreadsheat with duplicate codes
+      * "Data" in wrong format screen is displayed
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+      * Data template can be downloaded
+        🟠 iPhone 15 (0.24.4)
+          Dialog can't be dismissed [#24](https://github.com/rodekruis/reliefbox/issues/24)
+        🟠 Alcatel 1B (0.24.4)
+          Very minor: when template has been downloaded before, lives in downloads and name isn't changed, app navigates straight to distribution
+          workaround: leveraging the already downloaded template.
+      * "Go back to main menu" button works
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    * When adding a supported spreadsheet
+      * It navigates to distribution page
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+* Viewing beneficiary data
+  * Verify that:
+    When beneficiary data has been added
+      * All rows and columns from uploaded spreadsheet are displayed
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+      * Go back to main menu button results in navigation to distribution
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    When no beneficiary data has been added
+      * "No beneficiary data found!" message is shown
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+      * Go back to main menu button results in navigation to distribution
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+* Starting / resuming a distribution
+  * Verify that:
+     * Tapping "Using camera" button results in scanning input screen
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+     * Tapping "By typing" button results in text input screen
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+* Checking code using camera
+  * Verify that
+    * Camera can be selected when there's multiple options available
+      ✅ iPhone 15 (0.24.4)
+        (on iPhone there's only one option)
+      ✅ Alcatel 1B (0.24.4)
+        (seemed to have only one option)
+    * Pointing at a code results in navigating to code verification result page
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+* Checking code by typing
+ * Verify that:  
+    * Code can be submitted
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+* Viewing code verification result page
+  * Verify that
+    * When code doesn't exist, it mentions that beneficary is not found
+      * Continue distribution works
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+      * Go back to main menu works
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    * When code is known and isn't scanned before
+      * Beneficiary data is reveiled using green box
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+      * Can be marked as recipient
+        * Results in code input using last used input method
+          ✅ iPhone 15 (0.24.4)
+          ✅ Alcatel 1B (0.24.4)
+      * Can be ignored by pressing continue distribution
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+      * Can be ignored by pressing go back to main menu
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    * When code is already submitted
+      * Beneficiary data is reveiled using red box
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+* Checking missing beneficiaries
+  * Verify that:
+    * When there's still beneficiaries left
+      * Only the non served beneficiaries are shown
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    * When all beneficiaries have been served
+      * No beneficiaries found message is shown
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+* Downloading beneficiary data
+  * Verify that:
+    * This results in a spreadsheet with all rows and columns from uploaded spreadsheet, but with two added columns that describe if and when the beneficiary has been marked as a recepient.
+      ✅ iPhone 15 (0.24.4)
+      ✅ Alcatel 1B (0.24.4)
+* Changing distribution
+  * Verify that
+      * They can be changed to
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+* Deleting a distribution
+  * Verify that:
+    * When there's no distributions
+      * "No distributions found!" is shown
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+      * "Create new distribution" button works
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+    * When there are distributions
+      * Distributions are listed and can be deleted upon confirmation and deletion can be canceled upon canceling
+        ✅ iPhone 15 (0.24.4)
+        ✅ Alcatel 1B (0.24.4)
+
+For extra endurance testing:
+* Make sure all of the above works with multiple distributions
+* Make sure all of the above works with both different and the same distribution lists
+
+Useful tool when testing
+[Online barcode generator](https://barcode.tec-it.com/en)
+
+#### Regression observations
+🟠 Huawei P30 (0.24.2), Alcatel 1B (0.24.4)
+  In some cases an action may result in "This site can't be reached" message. Restarting the app or going back and performing the action again, seems to resolve this. May be more stable on newer devices (currently unclear).
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,6 @@ __pycache__/ @@
     *.xlsx
     *.csv
     *.pdf
-    *.json
     # C extensions
     *.so
@@ Expand Down @@