= EdenMobile =
[[TOC]]

== Introduction ==

'''!EdenMobile''' is a mobile application for Sahana Eden.

== Overview ==

=== AngularJS ===

!EdenMobile uses the [https://angularjs.org AngularJS] !JavaScript MVC framework.

A good introduction into AngularJS can be found here:

 - [http://www.w3schools.com/angular W3Schools AngularJS Tutorial]

NB We use Angular 1.x as Angular 2.x use Typescript for all examples still...TS cannot be debugged live on the device (required for offline DB support) & transpiling the TS examples produces very bloated code.

=== Ionic ===

The !EdenMobile user interface is built with the CSS and !JavaScript components provided by the [http://ionicframework.com Ionic] framework.

Documentation of these components can be found here:
 - [http://ionicframework.com/docs/components Ionic CSS Components]
 - [http://ionicframework.com/docs/api JavaScript API]

''Note:'' !EdenMobile does ''not'' use the ''Ionic CLI'' for development and builds, but the Cordova CLI.

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''

----

DeveloperGuidelines