Snfn - A Sinatra application generator
Snfn is an opinionated generator for Sinatra projects. It can be configured using the following options:
-dDatabase. Options are "postgres," "mysql," "sqlite", and "mongo." Default is "sqlite."
--redisInclude Redis configuration options.
--no-databaseDon't include any database config options.
--no-herokuDon't include Heroku config options.
gem install snfn
Standard Heroku app, using sqlite for local development and PostgreSQL for production.
App without Heroku options and mysql config.
snfn my_app -d mysql --no-heroku
The template autoloads files in config/initializers and
/lib. Database configuration options are stored in
and are loaded via
Right now Snfn only comes out of the box with support for Unicorn, (the config file is stored at config/unicorn.rb), but changing it out for thin or mongrel is pretty trivial.
Sequel is used as an ORM for
relational databases, and migrations are stored in db/migrate.
Migrations can be run using the rake command
MongoMapper is used for Mongo apps, with the config options
stored in the same files as relational databases (
If there is any interest in supporting other ORMs like DataMapper or ActiveRecord, either please let me know or implement it yourself and send a pull request.
Set up on Heroku
By default, Snfn creates an app with the proper options for deployment on Heroku. To get Snfn up and running on Heroku:
- Install your gems with
- Create a new git repository:
git init .
- Make your first commit:
git add .; git commit -m "initial commit"
- Create a new heroku app:
bundle exec heroku create --stack cedar
- Deploy the app:
git push heroku master
To use PostgreSQL, MongoDB, or Redis on Heroku, you'll need to add the proper Heroku add-ons. The commands to do this are, respectively:
heroku addons:add shared-database # PostgreSQL heroku addons:add mongolab:starter # MongoDB heroku addons:add redistogo:nano # Redis
Contributing to snfn
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
- Fork the project
- Start a feature/bugfix branch
- Commit and push until you are happy with your contribution
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
Copyright (c) 2011 Zach Pendleton. See LICENSE.txt for further details.