By far the quickest way to get started with CFWheels is via Commandbox . Commandbox allows you to run CFML servers locally and can even run different Lucee and Adobe ColdFusion versions with just a configuration change.
With the CFWheels CLI module for Commandbox, we can even download and configure a new CFWheels application for you and setup a local development database - much like the Rails system on which it is based.
The first step is to get Commandbox downloaded and running. Commandbox is available for Windows, Mac & Linux, and even via homebrew or Yum/Apt.
Once installed, you can either click on the
box executable, or run
$box from a terminal.
Note: all commands on this page assume you're running from a commandbox shell: you can still run any of these commands from a standard terminal by prepending commands with
$ install cfwheels-cli
Installing this module will give you access to the
wheels set of sub commands.
You can get CFWheels two different ways in Commandbox; either run
install cfwheels which will simply download the latest stable release and add it to a folder called
CFWheels, or by using the wheels new command (recommended).
Most commands which have
wheels at the start needs to be run from the root of your site.
The new command needs some information at the prompts: It will ask you for:
- A Name for your application
- The default datasource name
- A reload Password
- And which CFML Engine you wish to use
In turn, your new CFWheels app will have a few things pre-configured to make your life easier, and then all you need to do is
start to get going!