Skip to content
dmcassel edited this page Aug 22, 2012 · 13 revisions

Welcome to the Roxy wiki!

Roxy consists of three components:

  • MVC Framework - Scaffolding to make writing code easier.
  • Unit Testing Framework
  • Deployer - allows you to easily scaffold and deploy your application. So easy that you can have an application up and running in 5 minutes or less.

##Overview The Roxy framework relies on convention over configuration. It consists of deploy and unit test components, as well as an approach for building applications. The build component uses a configuration file that specifies application server and database settings, with a reasonable set of defaults provided as a template. It provides a tool to easily build the configuration, deploy source code and load data to multiple environments. The default files provide targets for local, dev and prod environments.

The application development portion of the framework provides a Model-View-Controller setup, allowing for well structured applications. The Controllers convert user inputs to values that can be passed to library module functions. The Models encapsulate functionality that relates to some concept in the application (for example, you might have a model library module that contains the functions related to managing users in your application). The Views handle the presentation logic. This separation isolates the business logic, simplifying the writing of unit tests. Isolating presentation layer functionality means that the same endpoint can serve up HTML, XML, or JSON.

QuickStart

See the Quickstart to get started with Roxy. You should be able to have an application up and running in minutes.

Advanced Topics

URL Rewriting

See Roxy URL Rewriting for information on how Roxy routes URLs. This page also contains information on overriding the Roxy Rewriter.

Configuring Roxy Options

See Overriding Roxy Options for information on how to customize Roxy.

Troubleshooting

Having trouble? Try the Troubleshooting page.