{"id":22192565,"url":"https://github.com/3sidedcube/arc-cie-android-client","last_synced_at":"2025-03-24T20:45:47.655Z","repository":{"id":79436375,"uuid":"111910553","full_name":"3sidedcube/arc-cie-android-client","owner":"3sidedcube","description":null,"archived":false,"fork":false,"pushed_at":"2017-11-24T11:31:59.000Z","size":25742,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-30T01:22:40.438Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3sidedcube.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-24T11:22:20.000Z","updated_at":"2020-03-18T20:59:00.000Z","dependencies_parsed_at":"2023-03-12T08:11:21.435Z","dependency_job_id":null,"html_url":"https://github.com/3sidedcube/arc-cie-android-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Farc-cie-android-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Farc-cie-android-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Farc-cie-android-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Farc-cie-android-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3sidedcube","download_url":"https://codeload.github.com/3sidedcube/arc-cie-android-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245351757,"owners_count":20601090,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-02T12:26:29.559Z","updated_at":"2025-03-24T20:45:47.634Z","avatar_url":"https://github.com/3sidedcube.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readme\n\nWelcome to the Cash in Emergencies app source code.\n\nThe app is designed to be a tool for ARC to distribute cash during emergency situations. The requirement for distributing cash is to follow certain guidelines outlined in documents served by a Document Management System.\n\n## Usage\n\nImport the project into Android Studio by importing the `settings.gradle` file.\n\nThe main entry point to the application is the [MainApplication.kt](app/src/main/java/com/cube/arc/cie/MainApplication.kt) singleton. Here the analytics helper and the `DirectoryManager` class is initialised.\n\n`DirectoryManager` is the main 'brain' of the application, this deals with loading the app content structure into models and provides various convinience methods (as part of the DMSDK). Extension method/properties can be found in [lib/util/](app/src/main/java/com/cube/lib/util/)\n\nThe `workflow` section of the app is the main feature, which displays a multi-nested structure of `Directory`s with related documents attached to those directories. These contain the tools and documents necessary for (xxx) to follow the procedure and protocol to distribute cash in an emergency.\n\nEach feature of the app is split into its own package with a standard sub-package structure with a corresponding `res` folder.\n\nFor example, the `workflow` feature has the following sub packages\n\n- workflow/activity\n\nThis package hosts all the activities that are used in or as part of the workflow feature\n\n- workflow/adapter\n\nThis package hosts all recycler adapters\n\n- workflow/fragment\n\nThis package hosts all the fragments\n\n- workflow/manager\n\nThis package hosts all the manager singletons\n\n- workflow/model\n\nThis package hosts all the data models\n\n- workflow/view\n\nThis package hosts all the view holders used in the recycler adapter\n\n- res-screen/workflow/\n\nThis resource package hosts all views that are used within the workflow feature only. Any other view/resource that is used app-wide is defined in the default `res-main` folder\n\nThe only exception is the `com/cube/arc/cie` package. This is the 'main' entry to the app and hosts any source file that is used app-wide or is a small sub-feature that doesnt warrant it's own sub-package.\n\n## Pre-requisites\n\nThis project requires the [DMSDK]() to function, this can be located in the `sdk/dmsdk/` folder.\n\nAlso required is Android Studio 3, Kotlin lang version `1.1.3-2`\n\nThe app is built with android API `17` as minSDK and currently only supports up to API `25`\n\n## Build values\n\nBuild values are required for the app to work correctly, see [example.properties](app/example.properties) for all values\n\n## License\n\nBSD 3-Clause License\nCopyright (c) 2017, 3 SIDED CUBE\nAll rights reserved.\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n* Redistributions of source code must retain the above copyright notice, this\n  list of conditions and the following disclaimer.\n* Redistributions in binary form must reproduce the above copyright notice,\n  this list of conditions and the following disclaimer in the documentation\n  and/or other materials provided with the distribution.\n* Neither the name of the copyright holder nor the names of its\n  contributors may be used to endorse or promote products derived from\n  this software without specific prior written permission.\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Farc-cie-android-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3sidedcube%2Farc-cie-android-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Farc-cie-android-client/lists"}