bhavikpatel/tables

ODK-X Tables is a data curation and visualization application running on your mobile device.

Tables

This project is actively maintained

It is part of the ODK-X Android tools suite.

ODK-X Tables is a program that allows you to visualize and edit data, revisiting existing data and syncing it with an ODK-X Aggregate instance in the cloud.

Instructions on how to use Tables can be found here.

The developer wiki (including release notes) and issues tracker are located under the ODK-X Tool Suite project.

Engage with the community and get technical support on the ODK-X forum

Setting up your environment

General instructions for setting up an ODK-X environment can be found at our Developer Environment Setup wiki page.

Install Android Studio and the SDK.

This project depends on ODK's androidlibrary and androidcommon projects; their binaries will be downloaded automatically fom our maven repository during the build phase. If you wish to modify them yourself, you must clone them into the same parent directory as tables. You directory stucture should resemble the following:

    |-- odk-x

        |-- androidcommon

        |-- androidlibrary

        |-- tables

• Note that this only applies if you are modifying the library projects. If you use the maven dependencies (the default option), the projects will not show up in your directory.

ODK-X Service MUST be installed on your device, whether by installing the APK or by cloning the project and deploying it. ODK-X Survey also integrates well with ODK-X Tables, but is not required.

Now you should be ready to build.

Building the project

Open the Tables project in Android Studio. Select Build->Make Project to build the app.

Running

Be sure to install ODK-X Services onto your device before attempting to run Tables.

Running tests

When running tests from Android Studio, execute adb shell pm grant org.opendatakit.tables android.permission.SET_ANIMATION_SCALE in the terminal first.

Source tree information

Quick description of the content in the root folder:

|-- tables_app     -- Source tree for Java components

    |-- src

        |-- main

            |-- res     -- Source tree for Android resources

            |-- java

                |-- org

                    |-- opendatakit

                        |-- tables     -- The most relevant Java code lives here

        |-- androidTest    -- Source tree for Android implementation tests

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.