# Hull

hull is a command line helper that will setup a complete application scaffold, so you can begin working straight away.
It will ask you a few questions, such as your client Id, application Id, and application Secret, and will configure the app to use them.

For now, only a sinatra template is included.  
It has several nice features :  

* Coffeescript, Compass and Sprockets integration
* a `rake assets:precompile` task to precompile your assets
* a Settings file (config/settings.yml) containing sensible defaults
* Guard and LiveReload for quick iteration
* It is set up to work out of the box with Pow and Heroku.

## Installation

Install it with :

    $ gem install hullapp
    
## Usage

Usage:

    hull new APP_NAME

Options:

    -t, [--template=TEMPLATE]      # Choose the template to use
    -f, [--force]                  # Don't ask for confirmation
        [--client-id=CLIENT_ID]    # Configure client_id
        [--app-id=APP_ID]          # Configure app_id
        [--app-secret=APP_SECRET]  # Configure app_secret

The app will ask you if you want to integrate with Pow and install the gems. If you do, your app will be ready to work.

#### RVM users : 
Due to security restrictions, you will need to enter the directory, accept the `.rvmrc`, and launch `bundle install` manually 

## Working with hull
Launch guard with :

    guard start
    
in your newly created application's directory. Livereload will be activated and will refresh your browser for you.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request


# License
(The MIT License)

Copyright © 2012 hull
hull.io

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 OR COPYRIGHT HOLDERS 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.