Directory Structure
Basic directory structure
The ax system is structured in three basic folders: core
, modules
and templates
.
AX Projects are generally developed in interchangable modules, or typically one module, which reside inside the module folder. Below you can find an interactive version of the ax structure tree. Check for the modules inside the module folder.
- core - ax's core, this is usually untouched
- ajax
- css
- imgs
- js
- php
- modules - this is where your main development will take place
- _System - system module, this is usually untouched
- _db
- ajax
- classes
- css
- do
- dp
- forms
- js
- pages
- php
- sopts
- DemoCarpool - Demo Carpool folder, can be deleted
- _db
- do
- dp
- forms
- pages
- php
- sopts
- DemoContractor - Demo Contractor folder, can be deleted
- _db
- classes
- css
- do
- dp
- forms
- imgs
- js
- pages
- recpicker
- reports
- sopts
- DemoPlayG - Demo PlayGround folder, can be deleted
- _db
- do
- dp
- forms
- pages
- recpicker
- reports
- sopts
- ModuleXY - This could be your first application folder
- ModuleXYZ - This could be a side application folder
- _System - system module, this is usually untouched
- templates - for skinning, logos and brandmarking
- default - default template, usually untouched
- templateXY - build your own template, skinning
Common Module subfolders
Modules can hold a variety of subfolders, here are the most common one's:
- ModuleXY
- _db - installation state of the corresponding tables
- _data - binary data folder, if needed
- ajax - ajax sidekicks, if needed
- bin - system scripts, if needed
- classes - computational classes, if needed
- css - additional style sheets
- do - all module DataObjects
- dp - all module DataProcessors
- et - all module ET's, if needed (soon)
- forms - all module Forms
- imgs - additional images
- install - install / uninstall scripts, if needed (soon)
- js - additional JavaScript files, libraries, etc.
- pages - all module Pages
- recpicker - all module RecordPickers
- reports - all module Reports
- sopts - all module Select Options
Note: all folders are optional, except
pages
, which should
at least hold one page {ModuleXY}.php as your starting point. On average an AX module will hold at least do
,
dp
, forms
, pages
.
AX means freedom:
- you are free to diversify your project into as many modules as you want
- you are free to develop and deploy as many modules as you want
- the AX ecosystem is capable to serve an unlimited amount of modules
- modules can be installed, upgraded and deinstalled at any time