Developer Guidelines

Getting Started

• The Basics
• Understanding the Domain
• Tutorials

Development Enviroment

• Install a Development Enviroment
• Git Version Control
• Eclipse debugger

Development Process

We define requirements:

• Projects
• BluePrints

Designs should focus on Usability:

• Usability

Designs should fit within our overall architecture:

• Architecture

We write Tests:

• Testing

We keep code conventions to maximise readability & consistency:

• Code Conventions

Code should be documented:

• Documentation

Code should be able to perform well at scale:

• Optimisation

Debugging Tips:

• FAQ
• Python
• JavaScript
• XSLT - Stylesheets for XML & JSON Import/Export

Framework

• Sahana Eden Framework: S3
  • S3 API Guide
  • DataTables

• Database Synchronization
• GIS - Mapping
• Internationalization
• Libraries
  • SVG - One way of producing Charts
• Menus
• Messaging
• Minify JS & CSS
• Mobile
  • EdenMobile
• Person Entity Hierarchy
• Popups
• PrePopulate- initialising the database with lookup lists &/or demo data
• Templates for instance configuration
  • Custom Pages
  • Deployment Settings
• Template Plugins
• Themes
• Save Search and Subscription
• Scheduler - push long-running tasks async as well as have tasks run to a schedule (e.g. recurring daily)
• Search
• User Management
• Web Services

Modules

• Logistics
• Organisations
• Survey
• WebSetup

Other Resources

• Tips - useful links to explore

Translations

These are Translated versions of the documentation, which may be outdated compared to the English originals

• German