DEVELOPING.md

Set up your development environment

• Install Android Studio
• Open Tools > Android > SDK Manager, make sure you have these modules installed:
  • Tools > Android SDK Platform-tools 19.0.1
  • Tools > Android SDK Build-tools 19.0.3
  • Android 4.3 (API 18) > SDK Platform (you can use Android 4.4/API 19 too)
  • Extras > Android Support Repository
  • Extras > Android Support Library
• Compile and run unit-test:
  • Run test server in the terminal: node test-server
  • In Android Studio, right-click on strong-remoting-android and select "Run All Tests"
  • Add an emulator configuration in AVD manager (you will do this only once)
  • Watch the tests pass.
• Run the Gradle task dist to create a ZIP archive containing all JARs needed for using LoopBack Android SDK in an Eclipse ADT project. The archive will be created in build/distributions/.
• Run the Gradle task publishToMavenLocal to publish artefacts to your local Maven cache. This will way you can test the changes in your application and/or other modules before publishing an official version.

Update the auto-generated API javadoc

Follow these steps to update the API documentation at http://docs.strongloop.com:

1. Update javadoc files

   $ rm -rf build/docs/javadoc/
   $ ./gradlew updateApiDocs -P version={version-to-print-in-docs} \
      -P strongRemotingVersion={version-to-reference}
   

2. Commit your changes to git

   $ git add docs/api
   $ git commit
   # enter commit message
   $ git push
   

3. Submit a GitHub pull request (see CONTRIBUTING.md).