Conventions

The core conventions delineate the contract between ColdBox and you for file/directory locations and more. Below is a table of the core conventions:

Directory/File Conventions

• /config - Where configuration files are stored

  • /Coldbox.cfc - Your application configuration object (optional )

  • /CacheBox.cfc - Your application CacheBox configuration (optional )

  • /Router.cfc - Your application URL Router (optional )

  • /Scheduler.cfc - Your application global task scheduler (optional)

  • /WireBox.cfc - Your application WireBox Configuration (optional )

• /handlers - This holds the app's event handlers (controller layer)

• /includes - For public assets, helpers and i18n resources

  • /css - This can hold your CSS (optional)

  • /js - This can hold your JavaScript (optional)

• /layouts - Your HTML layouts (view layer)

• /models - This holds your app's CFCs (model layer)

• /modules - This holds the CommandBox tracked modules

• /modules_app - This holds your app's modules

• /tests - Your test harness, including unit and integration testing

  • /specs - Where your test bundles go

• /views - Your HTML views will go here (view layer)

Execution Conventions

ColdBox also has several execution conventions. This means that we have a convention or a default for the event, action, and layout to be used if you do not tell it what to use: