This project is actively maintained
It is part of the ODK-X Android tools suite.
Instructions on how to use Survey can be found here.
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
This project depends on ODK-X'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 survey. Your directory structure should resemble the following:
|-- odk-x |-- androidcommon |-- androidlibrary |-- survey
- 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.
Now you should be ready to build.
Building the project
Open the Survey project in Android Studio. Select
Build->Make Project to build the app.
Be sure to install ODK-X Core onto your device before attempting to run Survey.
Source tree information
Quick description of the content in the root folder:
|-- survey_app -- Source tree for Java components |-- src |-- main |-- res -- Source tree for Android resources |-- java |-- org |-- opendatakit |-- survey |-- android -- 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:
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 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.