Skip to content

c7/hazel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hazel

A simple Sinatra app generator, heavily based on snfn.

Using Hazel

Installation

gem install hazel

Configuration

  • --capistrano Include Capistrano
  • -d Database. Options are "postgres," "mysql," "sqlite", and "mongo." Default is ""
  • --redis Include Redis configuration options.
  • --rvm Create .ruby-version (ruby-2.1.0) and .ruby-gemset
  • --bundle Run bundle after generating the app
  • --git Initialize a Git repository

Example

Standard app, using sqlite.

hazel my_app

App using MySQL and Redis.

hazel my_app -d mysql --redis

App using MongoDB and Redis, then run bundle install.

hazel my_app -d mongo --redis --bundle

App using Redis, RVM, and Git repo

hazel my_app --redis --rvm --git-repo

After Hazel is done generating an app, you can cd into your apps directory and rackup

cd my_app; rackup

Architecture

The template autoloads files in config/initializers and /lib. Database configuration options are stored in config/db.yml and are loaded via config/initializers/database.rb.

DB Setup

Sequel is used as an ORM for relational databases, and migrations are stored in db/migrate. Migrations can be run using the rake command rake db:migrate.

mongodb_model is used for Mongo apps, with the config options stored in the same files as relational databases (config/db.yml and config/initializers/database.rb).

More information

License

Copyright (c) 2014 Peter Hellberg

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.