Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 4.45 KB

README.md

File metadata and controls

62 lines (40 loc) · 4.45 KB
Raw

ODK-X Notify (Desktop)

Platform License

This project is under development.

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

The desktop application is for supervisors to create and send notifications to their field workers for better coordination of their work. The mobile application is an Android app that receives these notifications. The client can send notifications to all or a group of workers. These groups can either be an ODK Groups or a custom groups created in this application. For the custom groups, users are required to scan the QR code using ODK-X Notify generated by the admin after creating the group to be part of the group. Whereas members of ODK Groups are added by default. 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

  1. Download and install Git and add it to your PATH

  2. Download and install IntelliJ IDEA

  3. Fork the collect project (why and how to fork)

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

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

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

  1. Open the project in the folder of your clone from IntelliJ IDEA ide.

  2. To run the project, click on the green arrow at the top of the screen. This project uses the Java library,called JavaFX,which is used to develop a desktop application as well as Rich Internet Applications(RIA).This library supports the .fxml files. But JavaFX is not supported in the latest Java version, but is supported in versions like Java 8,Java 9 and Java 10.For java 11, the library package have to be installed separately. This can be done using the link given below: https://gluonhq.com/products/javafx/

  3. Click on the configure option after you run the app for the first time.

  4. Create a Firebase project and add necessary data to sync the app with firebase. Step by step instructions for creating a Firebase project can be found here.

To build an executable JAR using Gradle
  1. Build executable JAR by
            ./gradlew build (for Linux)
            gradlew.bat build (for Windows)
  1. A JAR will be built inside build/libs/, you can run the JAR by
           java -jar name_of_jar.jar

Prerequisites

ODK-X Sync Endpoint server is needed for the application to run. Once the server is up, enter the url in configure section of the app. Users with 'SITE_ACCESS_ADMIN' role can only access the application.

How to contribute

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

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

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.