odk-x / skunkworks-bat Goto Github PK

Skunkworks-bat is an Android app for field workers that receives notifications sent by their supervisors through skunkworks-parrot.

License: Apache License 2.0

Java 100.00%

skunkworks-bat's Introduction

ODK-X Notify (Mobile)

This project is under development.

ODK-X Notify has 2 components: a desktop application and a mobile application.

The mobile application an Android app for field workers that receives notifications sent by their supervisors through the ODK-X Notify desktop application. ODK-X Notify uses Firebase Cloud Messaging for receiving notifications. It is part of ODK-X, a free and open-source set of tools which help organizations author, field, and manage mobile data collection solutions. Learn more about the Open Data Kit project and its history here and read about example ODK deployments here.

Setting up your development environment

Download and install Git and add it to your PATH
Download and install Android Studio
Fork the collect project (why and how to fork)

Clone your fork of the project locally. At the command line:

 git clone https://github.com/YOUR-GITHUB-USERNAME/skunkworks-bat

If you prefer not to use the command line, you can use Android Studio to create a new project from version control using https://github.com/YOUR-GITHUB-USERNAME/skunkworks-bat.

Open the project in the folder of your clone from Android Studio.
Create a Firebase project and add the google-services.json file in your android app module root directory. Step by step instructions for creating a Firebase project can be found here.
To run the project, click on the green arrow at the top of the screen. The emulator is very slow so we generally recommend using a physical device when possible.
Add the google-services.json file (obtained in step 2) in your phone's external storage at the following location: /opendatakit/default/config/assets/google-services.json.

Prerequisites

ODK-X Services is needed to be installed in the device for the app to work. The application sync user's infromation from ODK Services.

How to contribute

If you’re new to ODK-X you can check out the documentation:

https://docs.odk-x.org

Once you’re up and running, you can choose an issue to start working on from here:

https://github.com/odk-x/tool-suite-X/issues

Issues tagged as good first issue should be a good place to start.

Pull requests are welcome, though please submit them against the development branch. We prefer verbose descriptions of the change you are submitting. If you are fixing a bug please provide steps to reproduce it or a link to a an issue that provides that information. If you are submitting a new feature please provide a description of the need or a link to a forum discussion about it.

Links for users

This document is aimed at helping developers and technical contributors. For information on how to get started as a user of ODK-X, see our online documentation, or to learn more about the Open Data Kit project, visit https://odk-x.org.

skunkworks-bat's People

Contributors

Stargazers

Watchers

skunkworks-bat's Issues

FirebaseApp has not been initialized properly.

W/System.err: java.io.FileNotFoundException:/storage/emulated/0/opendatakit/default/config/assets/google-services.json (No such file or directory)
W/System.err: at java.io.FileInputStream.open0(Native Method)
at java.io.FileInputStream.open(FileInputStream.java:200)
at java.io.FileInputStream.(FileInputStream.java:150)
at org.odk.odknotifications.Activities.MainActivity.loadJSONFromAsset(MainActivity.java:134)
at org.odk.odknotifications.Activities.MainActivity.readConfigFile(MainActivity.java:457)
at org.odk.odknotifications.Activities.MainActivity.requestStoragePermission(MainActivity.java:494)
at org.odk.odknotifications.Activities.MainActivity.onCreate(MainActivity.java:97)

Group Info is not showing anywhere.

Once we are out of group creating window, there's no way to view group info (ex. QR code, joining link).

Starting issue:

It shows on starting please add odk dependencies to continue.
Nothing like that is mentioned in readme.

Home Screen is empty.

Current Behaviour
Home screen shows nothing for now.

Expected Behaviour
I think there should be a list of all the notifications on the home screen with an option to filter w.r.t group and also an option to sort according to our need.

gradlew needs chmod +x

The gradle wrapper should be executable from the command line.

Firebase storing only one group under clients database

Screenshot

Expected Behaviour

It should store all the subscribed groups and should also able to fetch on clicking sync option.

I'm working on it.

Delete google-services.json file.

It's a confidential file and it shouldn't be available on any public platform.

Add issue and PR template

Currently, there is no issue and PR template
Add issue and PR template like odk collect

Other Information

please have a look here for the template of odk collect

Add permissions requests

Currently the user must open Services first to grant permissions. This app should handle its permissions requests.

Multiple anonymous users results in overwrite of data

Each user data should be stored under a unique key but here all the anonymous data is stored at one place which will result in inconsistency.

Application crashes when account is not configured and sync button from the menu is clicked

Android Device Used:
Xiaomi Redmi Note 5, Android Api 27.
Problem Description
When odk services isn't configured the sync button causes application to crash instead of an error message.
Steps To Reproduce

Download the ODK notify App on your android Device.
Make sure you havent configured the server in Odk services application . If configured remove the configuration.
Open the application and select the Sync Option from the menu.
Expected Behaviour
Sync is not possible Without Server configuration, so the option should be disabled .
. Gif image attached

Application Crashes on selecting sync option from menu .

Application Crashes on selecting sync from menu when sync endpoint is not configured and firebase is configured .
steps to reproduce -:

1 . configure firebase and download the google-services.json file

2 . manually add the google-services.json file to its location .

3 . open the app , the sync button gets enabled as the google-services.json file is found ,
click on the sync button the application would crash .

Migrating to AndroidX from support lib

@jbeorse can we migrate to androidX since android support lib is deprecated, as the android documentation says

You can continue to use the support library. Historical artifacts (those versioned 27 and earlier, and packaged as android.support.*) will remain available on Google Maven. However, all new library development will occur in the AndroidX library.

We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX as well.

New Notification does'nt appear in application when application is open.

When the application is open and a new notification is received the notification is delivered but in the application it is not visible .
The application has to be closed and opened again for the new notification to appear .

Steps to reproduce :-
1 . open the application ( configured firebase and synced ).
2 . send a notification .
3 . close and open the application again .

after the 3rd step the notification would be visible in the application but it would not be visible in step 2 after receiving the notification .

Document the instructions for setting up the project.

Issue

Instructions to setup Firebase configurations externally for the app are missing.

App is crashing when sync button is clicked

Show a message when there's no notification present on Home screen

Issue

Home screen appears empty when there's no notification present as shown below in given screenshot.

Expected

It should display some message like "No Data available" or "No Notifications Received Yet" something like that. For example, see the below screenshot: