Directory Structure

Finding your way around a Wheels application.

After downloading and unzipping Wheels, here's the directory structure that you will see:

Directory Structure

cli/ core/ design_docs/ docs/ examples/ lib/ templates/ test-artifacts/ tests/ tools/ .cfformat.json .editorconfig .env CFConfig.json CHANGELOG.md compose.yml server.json

Quick Summary

Your configuration settings will be done in the /templates/base/src/config directory.

Your application code will end up in four of the folders, namely templates/base/src/app/controllers, templates/base/src/app/events, templates/base/src/app/models, and templates/base/src/app/views.

Static media files should be placed in the templates/base/src/public/files, templates/base/src/public/images, templates/base/src/public/javascripts and templates/base/src/public/stylesheets folders.

Place anything that need to be executed outside of the framework in the templates/base/src/public/miscellaneous folder. The framework does not get involved when executing .cfm files in this folder. (The empty Application.cfc takes care of that.) Also, no URL rewriting will be performed in this folder, so it's a good fit for placing CFCs that need to be accessed remotely via <cfajaxproxy> and Flash AMF binding, for example.

Place Wheels plugins in the templates/base/src/app/plugins folder.

The framework itself is in the core/src/wheels directory. Please go in there and have a look around. If you find anything you can improve or new features that you want to add, let us know!

Detailed Overview

Let's go through all the files and directories now, starting with the ones you'll spend most of your time in: the code directories.

templates/base/src/app/controllers

This is where you create your controllers. You'll see a file in here already: Controller.cfc. You can place functions inside this Controller.cfc to have those functions shared between all the controllers you create(This works because all your controllers will extend Controller.).

templates/base/src/app/models

This is where you create your model files (or classes if you prefer that term). Each model file you create should map to one table in the database.

The setup in this directory is similar to the one for controllers, to share methods you can place them in the existing Model.cfc file.

templates/base/src/app/views

This is where you prepare the views for your users. As you work on your website, you will create one view directory for each controller.

templates/base/src/app/events

If you want code executed when ColdFusion triggers an event, you can place it here (rather than directly in Application.cfc).

templates/base/src/config

Make all your configuration changes here. You can set the environment, routes, and other settings here. You can also override settings by making changes in the individual settings files that you see in the subdirectories.

templates/base/src/public/files

Any files that you intend to deliver to the user using the sendFile() function should be placed here. Even if you don't use that function to deliver files, this folder can still serve as file storage if you like.

templates/base/src/app/global

For application-wide globally accessible functions

templates/base/src/public/images

This is a good place to put your images. It's not required to have them here, but all Wheels functions that involve images will, by convention, assume they are stored here.

templates/base/src/public/javascripts

This is a good place to put your JavaScript files.

templates/base/src/public/stylesheets

This is a good place to put your CSS files.

tests/Testbox

This is where unit tests for your application should go

templates/base/src/public/miscellaneous

Use this folder for code that you need to run completely outside of the framework. (There is an empty Application.cfc file in here, which will prevent Wheels from taking part in the execution.)

This is most useful if you're using Flash to connect directly to a CFC via AMF binding or if you're using <cfajaxproxy>in your views to bind directly to a CFC as well.

templates/base/src/app/plugins

Place any plugins you have downloaded and want installed here.

templates/base/src/app/migrator *

Database Migration CFC files and generated SQL files (This directory will only visible once you start using the migrator)

core/src/wheels

This is the framework itself. When a new version of Wheels is released it is often enough to just drop it in here (unless there has been changes to the general folder structure).

templates/base/src/.htaccess

This file is used by Apache, and you specifically need it for URL rewriting to work properly. If you're not using Apache, then you can safely delete it.

templates/base/src/public/urlrewrite.xml

If you use Tomcat and Tuckey, or CommandBox URL Rewriting, you'll need this file. Otherwise, you can safely delete it.

templates/base/src/public/Application.cfc and templates/base/src/public/index.cfm

These are needed for the framework to run. No changes should be done to these files.

You can add more directories if you want to, of course. Just remember to include a blank Application.cfc in those directories. Otherwise, Wheels will try to get itself involved with those requests as well.

\