/mack

A Ruby web application framework

Primary LanguageRuby

=Hello, and welcome to Mack!

Mack is a Ruby web application framework. It takes the best ideas from several frameworks, including Rails, Merb, and Ramaze, and tries to improve upon those ideas. Mack uses Rack[http://rack.rubyforge.org] as an abstraction layer to separate itself from it's deployment.

Mack is also about performance. Because Mack uses technologies like Thin[http://code.macournoyer.com/thin] and Rack[http://rack.rubyforge.org], Mack is a multithreaded and fast framework. Current tests show Mack/Thin[http://code.macournoyer.com/thin] is twice as fast as Rails/Mongrel. Mack tries to strip out a lot of the cruft from other frameworks, like Rails, and delivers you a fast, efficient framework designed for actual real world development.

==Installation
  $ sudo gem install mack

==Getting Started
First things first, let's generate your application:
  $ mack <app_name>

To run a Mack application:
  $ rake script:server

It will try and run the app using the following servers in this order:
  * Thin
  * Mongrel
  * WEBrick

rake script:server takes the following options:
  $ rake script:server PORT=<port> Mack::Configuration.env=<environment> HANDLER=<rack_handler>
  
The port and rack_handler flags don't apply if you're using Thin[http://code.macournoyer.com/thin] to run the app, which is the default if it is installed. Use the thin.yml file in your application's config directory to configure Thin. The rack_handler one will allow you to switch which server is used to run the app. See Rack for more Rack::Handlers.
  
The environment can also be changed like this:
  $ rake script:server#<environment>
  
You can also run:
  $ rake console
This will give you console level access to your application.


==Contact
Please mail bugs, suggestions and patches to <bugs@mackframework.com>.

On the web at: http://www.mackframework.com

==License and Copyright
Copyright (C) 2008 Mark Bates, http://www.mackframework.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

==Other documentation:
* Rack[http://rack.rubyforge.org]
* Thin[http://code.macournoyer.com/thin]