Changes between Version 27 and Version 28 of DeveloperGuidelines/EdenMobile

Timestamp:

03/29/17 11:56:06 (9 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/EdenMobile

@@ -2 +2 @@
 [[TOC]]
 
+== Introduction ==
+
 '''!EdenMobile''' is a mobile application for Sahana Eden.
 
-Related pages:
+== Overview ==
 
- - Framework:
-  - [wiki:DeveloperGuidelines/EdenMobile/Database EdenMobile Database]
-  - [wiki:DeveloperGuidelines/EdenMobile/i18n EdenMobile i18n] (Translation of UI messages)
- - Development Help:
-  - [wiki:DeveloperGuidelines/EdenMobile/Conventions EdenMobile Coding Conventions]
-  - [wiki:DeveloperGuidelines/EdenMobile/Debugging EdenMobile Debugging]
-  - [wiki:DeveloperGuidelines/EdenMobile/Structure EdenMobile Directory Structure]
-
-== Development Environment ==
-
-Eden Mobile is built on the [https://cordova.apache.org Apache Cordova] platform (sometimes known as Adobe !PhoneGap).
-
-1. Cordova runs on '''NodeJS'''. If your OS distribution does not provide a NodeJS bundle, you can get one from here:
-
- - [https://nodejs.org/en/download https://nodejs.org/en/download]
-
-2. Use the NodeJS package manager ''npm'' to install Cordova:
-
-{{{
-npm install -g cordova 
-}}}
-
- See also: [https://cordova.apache.org/#getstarted https://cordova.apache.org/#getstarted]
-
-3. If you want to build and test !EdenMobile, you also need an SDK for the target platform, e.g.:
-
- - [https://developer.android.com/studio/index.html#downloads Android SDK]
-  - Ensure the SDK tools are in your PATH, e.g. for Windows 10:
-   * %USERPROFILE%\!AppData\local\android\sdk\platform-tools
-   * %USERPROFILE%\!AppData\local\android\sdk\tools
-
-4. You can fork/clone !EdenMobile from here:
-
- - [https://github.com/sahana/eden_mobile https://github.com/sahana/eden_mobile]
-
-5. Run the application
-
- - You canot run in the 'browser' platform as it doesn't support the local database
- - It is easier to run on a real device than the emulator
- - 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
-  - see also: [wiki:DeveloperGuidelines/EdenMobile/Debugging#RemoteDebuggingonAndroidDevice Remote-Debugging on Android Device]
- - to run on emulator you need to create an avd: {{{android avd}}}
-{{{
-cd eden_mobile
-npm install q-io
-cordova platform add android
-adb uninstall org.sahanafoundation.eden_mobile # Shouldn't be required but can be for some systems
-cordova run android # Builds apk & adb install platforms\android\build\outputs\apk\android-debug.apk
-}}}
 === AngularJS ===
 
@@ -77 +30 @@
 NB We use Ionic 1.x because we use Angular 1.x (see above)
 
+== Documentation ==
+
+ - Development
+   - [wiki:DeveloperGuidelines/EdenMobile/DevelopmentEnvironment Development Environment]
+   - [wiki:DeveloperGuidelines/EdenMobile/Conventions Coding Conventions]
+   - [wiki:DeveloperGuidelines/EdenMobile/Debugging Debugging]
+ - Architecture
+   - [wiki:DeveloperGuidelines/EdenMobile/Framework Framework]
+   - [wiki:DeveloperGuidelines/EdenMobile/Structure Application Structure]
+   - [wiki:DeveloperGuidelines/EdenMobile/Routing Routing and Controllers]
+   - [wiki:DeveloperGuidelines/EdenMobile/Directories Directory Structure]
+ - Reference
+   - [wiki:DeveloperGuidelines/EdenMobile/Services Services]
+   - [wiki:DeveloperGuidelines/EdenMobile/Directives Directives]
+   - [wiki:DeveloperGuidelines/EdenMobile/Settings Configuration Settings]
+   - [wiki:DeveloperGuidelines/EdenMobile/i18n i18n (Translation of UI messages)]
+ - Mobile Database
+   - [wiki:DeveloperGuidelines/EdenMobile/Database Database Structure]
+   - [wiki:DeveloperGuidelines/EdenMobile/FileStorage File Storage]
+ - Synchronisation
+   - [wiki:DeveloperGuidelines/EdenMobile/ServerAPI Server-side API]
+   - [wiki:DeveloperGuidelines/EdenMobile/DataFormats Data Formats]
+
+== !ToDo's ==
+
+ - ''tbw''
+
+== Releases ==
+
+ - ''tbw''
+
 ----