randallmeeker / cfwheels

An open source ColdFusion framework inspired by Ruby on Rails.

ColdFusion on Wheels

ColdFusion on Wheels provides fast application development, a great organization system for your code, and is just plain fun to use.

One of our biggest goals is for you to be able to get up and running with Wheels quickly. We want for you to be able to learn it as rapidly as it is to write applications with it.

Getting Started

In this Beginner Tutorial: Hello World, we'll be writing a simple application to make sure we have Wheels installed properly and that everything is working as it should. Along the way, you'll get to know some basics about how applications built on top of Wheels work.

Contributing

We encourage you to contribute to ColdFusion on Wheels! Please check out the Coding Guidelines for guidelines about how to proceed. Join us!

Running Tests

Note: CFWheels uses RocketUnit as its testing framework.

Before running tests, make sure that all debugging is turned OFF. This could add a consideral amount of time for the tests to complete and may cause your engine to become unresponsive.

1. Create a database on a supported database server name wheelstestdb. At this time the supported database servers are H2, Microsoft SQL Server, Oracle, PostgreSQL, MySQL.
2. Create a datasource in your CFML engine's administrator named wheelstestdb pointing to the wheelstestdb database and make sure to give it CLOB and BLOB support.
3. Open your browser to the CFWheels Welcome Page.
4. In the grey debug area at the bottom of the page, click the Run Tests link next the version number on the Framework line.

Please report any errors that you may encounter on our issue tracker. Please be sure to report the database engine (including version), CFML engine (including version), and HTTP server (including version).

Building and Releasing

Note: The build script has only been tested against Railo 3.3.0.007 or higher at this time.

1. Make sure the URL rewriting is OFF
2. Open wheels/version.cfm file and edit the version to correspond with the build.
3. Update wheels/CHANGELOG to reflect version and build date.
4. Point your browser to the build.cfm file (ex: http://localhost/builders/build.cfm).
5. The build will create a zip file named cfwheels.<version>.zip in parent directory of the repo.
6. Annouce and post the build to the Core Team.

Generating API Documentation

Note: The API generation script has only been tested against Railo 3.3.0.007 or higher at this time.

1. Make sure the URL rewriting is OFF
2. Point your browser to the API Generator at http://localhost/builders/api/index.cfm
3. The generator will automatically create all the pages for the Wheels API in wheels/docs/Wheels API

You may overload or overwrite any of the outputted API documentation by adding to the builders/api/overload.cfm. A diagram of the generated API structure is provided in the document.

If you are a developer building a syntax or code hinting library for Wheels for your favorite editor, you can automatically generate an XML formatted version of the API by passing ?xml=true to the API Generator URL:

http://localhost/builders/api/index.cfm?xml=true

This will create a file called cfwheels-api.xml in the directory above your Wheels project.

View API Documentation

You will need a Markdown viewer in order to view the documentation locally. If you use Google Chrome, you can install the Markdown Preview extension.

License

ColdFusion on Wheels is released under the Apache License Version 2.0.