RatPack

Get up and Running

Fork and clone this repo.
Run
```
bundle install
```
.
Start a local server with
```
shotgun
```
.
Start a console with
```
tux
```
.
Visit
```
localhost:9393
```
in your browser.

The Pack

	-- ratpack/
	+ -- Gemfile
	+ -- Rakefile
	+ -- config.ru
	+ -- app.rb
	+ -- lib/
	+ -- model.rb
	+ -- views/
	+ -- index.erb
	+ -- public/
	+ -- css/
	+ -- bootstrap.min.css
	+ -- bootstrap-responsive.min.css
	+ -- js/
	+ -- bootstrap.min.js
	+ -- img/
	+ -- glyphicons-halflings-white.png
	+ -- glyphicons-halflings.png

view raw ratpack hosted with ❤ by GitHub

Gemfile

	source :rubygems

	gem "sinatra"
	gem "sqlite3"
	gem "activerecord"
	gem "sinatra-activerecord"
	gem "rake"

	group :development do
	gem "shotgun"
	gem "tux"
	end

view raw ratpack-gemfile hosted with ❤ by GitHub

App Structure and Organization

Sinatra apps can be built a bunch of different ways. This is my way. I think it's pretty good.

Your app is wrapped in a class called

App

that extends

Sinatra::Application

. It is wrapped in a module that you should name with your project name.

	# app.rb

	module Name #change 'NAME' to your project name
	class App < Sinatra::Application

	#...all the stuff! (or at least, most of it)

	end
	end

view raw app-pt3.rb hosted with ❤ by GitHub

Sinatra runs on Rack! So we have a

config.ru

file. All we need to do in there is require our

app.rb

file and then run it:

	# config.ru

	require File.join(File.dirname(__FILE__), 'app.rb')
	run Name::App

view raw app-pt4.rb hosted with ❤ by GitHub

To get this running, we'll need to use the

sinatra

gem. This, and all of your Gemfiles are required in your app using Bundler at the very top of your

app.rb

	# app.rb

	require 'bundler'
	Bundler.require

view raw app-pt1.rb hosted with ❤ by GitHub

Last, but not least, let's configure a

public

folder for all our static assets (i.e. things that don't need to be compiled or rendered, like pictures and css.) We'll also define a

:root

. This goes inside our

App

class definition in the

app.rb

file.

	# app.rb

	configure do
	set :root, File.dirname(__FILE__)
	set :public_folder, 'public'
	end

view raw app-pt5.rb hosted with ❤ by GitHub

The Database!

Hell yes you can use ActiveRecord, even if you aren't in Rails. The structure Rat Pack provides is explained below. If you want more info on how to properly implement RESTful resources with AR in Sinatra, czech out this awesome tutorial.

Your sqlite database is made with the code below. Maybe rename
```
database.db
```
to something more related to your project.

# app.rb

set :database, "sqlite3:///database.db"

view raw app-pt6.rb hosted with ❤ by GitHub

All of your models in the

lib

directory are required in your app using this code:

	# app.rb

	Dir.glob('./lib/*.rb') do \|model\|
	require model
	end

view raw app-pt2.rb hosted with ❤ by GitHub

Since we are using ActiveRecord as our ORM, your models should extend

ActiveRecord::Base

like this:

	# /lib/model.rb

	class Model < ActiveRecord::Base
	#stuffs!
	end

view raw app-pt7.rb hosted with ❤ by GitHub

Routes, Helpers, and Views

If you're used to Rails, it's worth noting that Sinatra collapses routes controllers into the same blocks that exist inside our
```
App
```
class in
```
app.rb
```
. The Pack contains one as an example:

get '/' do

erb :index

end

view raw app-pt8.rb hosted with ❤ by GitHub

Sinatra allows you to use layouts, and by default will use the

layout.erb

file in the

views

folder. The one the Pack contains is shown below:

	<!doctype html>
	<html>
	<head>
	<link href="css/bootstrap.min.css" type="text/css" rel="stylesheet" />
	<link href="css/bootstrap-responsive.min.css" type="text/css" rel="stylesheet"/>
	</head>
	<body>
	<div class="container-fluid">
	<%= yield %>
	</div>
	<script src="/js/boostrap.min.js"></script>
	</body>
	</html>

view raw app-pt9.erb hosted with ❤ by GitHub

Note that whatever view you render will be inserted into the layout where

<%= yield %>

is.

Lastly, Sinatra doesn't come with the ability to support partials out of the box. Therefore, the pack comes with a helper to provide that functionality:

	helpers do
	def partial(file_name)
	erb file_name, layout => false
	end
	end

view raw app-pt10.rb hosted with ❤ by GitHub

Note: this is the absolute simplest way to implement partials in Sinatra. If you want to step it up, or just read more, check out this.

Contact

Ashley Williams

made Rat Pack for her students at the

Flatiron School

If you find an issue, please report it on github.

RAT PACK

a simple boilerplate for creating production-ready sinatra apps that use activerecord, sqlite, and twitter bootstrap