Changes between Version 27 and Version 28 of DeveloperGuidelines/EdenMobile


Ignore:
Timestamp:
03/29/17 11:56:06 (7 years ago)
Author:
Dominic König
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/EdenMobile

    v27 v28  
    22[[TOC]]
    33
     4== Introduction ==
     5
    46'''!EdenMobile''' is a mobile application for Sahana Eden.
    57
    6 Related pages:
     8== Overview ==
    79
    8  - Framework:
    9   - [wiki:DeveloperGuidelines/EdenMobile/Database EdenMobile Database]
    10   - [wiki:DeveloperGuidelines/EdenMobile/i18n EdenMobile i18n] (Translation of UI messages)
    11  - Development Help:
    12   - [wiki:DeveloperGuidelines/EdenMobile/Conventions EdenMobile Coding Conventions]
    13   - [wiki:DeveloperGuidelines/EdenMobile/Debugging EdenMobile Debugging]
    14   - [wiki:DeveloperGuidelines/EdenMobile/Structure EdenMobile Directory Structure]
    15 
    16 == Development Environment ==
    17 
    18 Eden Mobile is built on the [https://cordova.apache.org Apache Cordova] platform (sometimes known as Adobe !PhoneGap).
    19 
    20 1. Cordova runs on '''NodeJS'''. If your OS distribution does not provide a NodeJS bundle, you can get one from here:
    21 
    22  - [https://nodejs.org/en/download https://nodejs.org/en/download]
    23 
    24 2. Use the NodeJS package manager ''npm'' to install Cordova:
    25 
    26 {{{
    27 npm install -g cordova
    28 }}}
    29 
    30  See also: [https://cordova.apache.org/#getstarted https://cordova.apache.org/#getstarted]
    31 
    32 3. If you want to build and test !EdenMobile, you also need an SDK for the target platform, e.g.:
    33 
    34  - [https://developer.android.com/studio/index.html#downloads Android SDK]
    35   - Ensure the SDK tools are in your PATH, e.g. for Windows 10:
    36    * %USERPROFILE%\!AppData\local\android\sdk\platform-tools
    37    * %USERPROFILE%\!AppData\local\android\sdk\tools
    38 
    39 4. You can fork/clone !EdenMobile from here:
    40 
    41  - [https://github.com/sahana/eden_mobile https://github.com/sahana/eden_mobile]
    42 
    43 5. Run the application
    44 
    45  - You canot run in the 'browser' platform as it doesn't support the local database
    46  - It is easier to run on a real device than the emulator
    47  - to run on a real device, you need to enable 'Developer Options' by tapping 7 times on the 'Build Number' in the About section (http://www.greenbot.com/article/2457986/how-to-enable-developer-options-on-your-android-phone-or-tablet.html) and then open the new Developer Options panel & enable USB Debugging
    48   - see also: [wiki:DeveloperGuidelines/EdenMobile/Debugging#RemoteDebuggingonAndroidDevice Remote-Debugging on Android Device]
    49  - to run on emulator you need to create an avd: {{{android avd}}}
    50 {{{
    51 cd eden_mobile
    52 npm install q-io
    53 cordova platform add android
    54 adb uninstall org.sahanafoundation.eden_mobile # Shouldn't be required but can be for some systems
    55 cordova run android # Builds apk & adb install platforms\android\build\outputs\apk\android-debug.apk
    56 }}}
    5710=== AngularJS ===
    5811
     
    7730NB We use Ionic 1.x because we use Angular 1.x (see above)
    7831
     32== Documentation ==
     33
     34 - Development
     35   - [wiki:DeveloperGuidelines/EdenMobile/DevelopmentEnvironment Development Environment]
     36   - [wiki:DeveloperGuidelines/EdenMobile/Conventions Coding Conventions]
     37   - [wiki:DeveloperGuidelines/EdenMobile/Debugging Debugging]
     38 - Architecture
     39   - [wiki:DeveloperGuidelines/EdenMobile/Framework Framework]
     40   - [wiki:DeveloperGuidelines/EdenMobile/Structure Application Structure]
     41   - [wiki:DeveloperGuidelines/EdenMobile/Routing Routing and Controllers]
     42   - [wiki:DeveloperGuidelines/EdenMobile/Directories Directory Structure]
     43 - Reference
     44   - [wiki:DeveloperGuidelines/EdenMobile/Services Services]
     45   - [wiki:DeveloperGuidelines/EdenMobile/Directives Directives]
     46   - [wiki:DeveloperGuidelines/EdenMobile/Settings Configuration Settings]
     47   - [wiki:DeveloperGuidelines/EdenMobile/i18n i18n (Translation of UI messages)]
     48 - Mobile Database
     49   - [wiki:DeveloperGuidelines/EdenMobile/Database Database Structure]
     50   - [wiki:DeveloperGuidelines/EdenMobile/FileStorage File Storage]
     51 - Synchronisation
     52   - [wiki:DeveloperGuidelines/EdenMobile/ServerAPI Server-side API]
     53   - [wiki:DeveloperGuidelines/EdenMobile/DataFormats Data Formats]
     54
     55== !ToDo's ==
     56
     57 - ''tbw''
     58
     59== Releases ==
     60
     61 - ''tbw''
     62
    7963----
    8064