Community contributed recipes and techniques
CSS Ruby JavaScript
Latest commit 70c1b99 May 11, 2016 @kgrz kgrz Merge pull request #136 from sinatra/revert-70-reloader
Revert "WIP add recipe for sinatra::reloader"
Permalink
Failed to load latest commit information.
activity fix activities link Jul 21, 2013
asset_management Add deprecated warning Mar 10, 2016
config Reduce unicorn worker_processes Aug 8, 2015
databases Added databases/postgresql.md Dec 19, 2015
deployment
development Revert "WIP add recipe for sinatra::reloader" May 11, 2016
embed Stop by CTRL+C in "Embedding Sinatra within EventMachine" sample Aug 9, 2014
helpers Clean up recipes Dec 5, 2013
middleware Clearer implementation for Rack::Auth::Digest::MD5 Nov 18, 2015
models Update 'for' to 'each' making it more ruby like Mar 26, 2015
public Add a white background. Nov 23, 2013
testing Small addition to point out that this configuration works for RSpec 3… Dec 11, 2015
views fix slim md view Dec 22, 2015
.gitignore
Gemfile Add rudimentary HTTP caching Dec 27, 2014
Gemfile.lock Add rudimentary HTTP caching Dec 27, 2014
Procfile Add Unicorn instead of Thin to support Ruby 2.1.+ Dec 25, 2014
README.md Clean up recipes Dec 5, 2013
app.rb
config.ru require style Mar 17, 2013

README.md

Sinatra Recipes

Community contributed recipes and techniques for the Sinatra Web Framework.

Why yet another doc project?

Quite simply, the Sinatra README and Book have become long in the tooth.

This project is to extract any redundant and overlap between the two sources, and create a home for user contributed recipes and documentation to take form.

How can I help?

Got a recipe or tutorial for Sinatra? Awesome, this is the first place you should go if you're looking to contribute.

Once you have forked the project send a pull request, just be sure to follow the styling guidelines.

You can also get a hold of us on irc or the mailinglist.

Don't have any ideas? Check out the existing issue tracker for recipes that have been requested or are in progress.

Here's the run down

To get started you should clone the repository from GitHub:

git clone git://github.com/sinatra/sinatra-recipes.git

Now once you cd into sinatra-recipes you should see a few things.

First you should take note of the application files:

app.rb # a tiny application for displaying the contributed recipes
config.ru # rackup file for deploying to heroku
Gemfile # dependencies file for bundler to run the app

If you want to run the application yourself first you need the bundler gem.

gem install bundler

If you are on Rubinius make sure that you have the latest bundler version installed. Versions prior to 1.0.10 won't work.

# then install the application dependencies
bundle install

Once that is complete, you should only need to run rackup in the application root and visit: localhost:9292

Since the application just maps the flat files, you can browse either the source or the web app to view recipes.

If you check out the source you will see a few folders listed, in each folder there is a README.md that will briefly explain the topic. This can also be view by going to /p/:topic where topic is the folder you wish to view.

In each folder there should be a number of recipes pertaining to each topic.

On translations

Currently we're not supporting translations in the main repository.

However, if you'd like to maintain a fork for translating the docs then feel free to do so, and add your fork to the list of translations in the wiki.