DevEnv Setup

Niles Rogoff edited this page Jun 6, 2017 · 8 revisions

For Implementers

###Installing the Emulator Note: The Android emulator is slow and buggy. If you can deploy on a real Android device, we highly recommend that approach.

  1. The emulator comes with the Android SDK. Follow the instructions at downloading the SDK starter package. You do not have to install Eclipse or the ADT plugin at this stage.
  2. Install the version of Android SDK (2.3 up to 5.X) you'd like. Follow the instructions for adding components. We recommend SDK Platform Android 4.4.4, Android SDK Tools, and Documentation for Android SDK. If you are using Windows, also get the USB Driver.
  3. Create an Android Virtual Device -- the configuration information for the emulator. Follow the instructions at for creating an AVD. We recommend Android 4.4.4 with a 512MiB SD card. Leave the other settings at defaults.
  4. Once you create your AVD, you can select and start it.
  5. Search the software engineering support list for answers to your questions.

For Developers

Setup for Android

  1. Install your development environment. * If you are running the mainline/master branch versions of our tools (rev 126 or earlier), then install Eclipse, the Android SDK, and the ADT Plugin. * If you are running the development branch, then install Android Studio, Android SDK, and the ADT Plugin
  2. Install Hello World
  3. Read Git Tutorials. If you prefer a graphical interface, we recommend SourceTree
  4. Search the ODK software developer support list for answers to your developer questions. For general usability questions about ODK search the ODK community mailing list.

Setup for AppEngine

  1. Install Eclipse, Java SDK, Google Plugin
  2. Work through the Tutorial
  3. Read Git Tutorials. If you prefer a graphical interface, we recommend SourceTree
  4. Search the ODK software developer support list for answers to your developer questions. For general usability questions about ODK search the ODK community mailing list.

Setup for ODK 2.0 Tools

  1. Pull required projects from the remote repository into a single parent directory, containing a child directory for each project. For example your workspace might look like the following:

    |-- odk

       |-- androidcommon
    
       |-- androidlibrary
    
       |-- services
    
       |-- tables
    
       |-- survey
    
  2. Ensure child folders containing each project are named the same as the GitHub repositories (e.g., "projectname") for each respective project.

  3. Using Git, update each project to the development tip (rather than master -- note that playservices has no development tip at this time)

  4. Read the README.md for the project you wish to work on.

  5. Open the project you wish to work on in Android Studio or IntelliJ using "File->Open". Note that you do not want to import the project, just open it. Each project, including dependencies, must be opened in a separate window.

  • If you have not cloned the dependencies locally, they will be downloaded automatically. If you have cloned any of the dependencies (the library projects) locally, they should still be saved in the common parent directory, not in a subdirectory of the project that depends on it.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.