Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A Rack-based template that uses Sinatra_Synchrony to provide a fast base for building web services.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.bundle
config
lib
spec
vendor/cache
.gitignore
.rspec
.rvmrc
Gemfile
Gemfile.lock
Procfile
Procfile.dev
README.md
Rakefile
config.ru

README.md

Rocketship

Now super fast! (using sinatra_synchrony)

Overview

Ruby has some great micro-frameworks to jumpstart development of web services. But when you want to spin up a number of basic services using things like Sinatra, RestClient, and testing helpers such as RSpec, Capybara, and SimpleCov (not to mention dependency management using Bundler and a few simple Rake tasks), there's quite a lot of complexity and boiler-plate to deal with.

Want to just dive into development without browsing around for a while and setting things up? Working on multiple Sinatra apps and want a sane way to organize everything? Use Rocketship.

Usage

  • Install RVM and ruby-1.9.3

  • Clone this repository

  • Run bundle install --path vendor/ruby. Later, add gems you need to Gemfile, run bundle install, and Bundler will install and package up your new gems too.

  • Start building your project

  • Modify your app routes in config.ru

  • Add background processes and basically any process you need to run to start your app in Procfile.dev.

  • Procfile has been provided to allow you to easily deploy this on Heroku's Cedar stack. If you're only using Sinatra, it should be sufficient. Also, Sinatra-synchrony will speed your app up decently :)

  • Add specs in spec/

  • rake s to run your app

  • Bump version number in lib/project.rb

You can add your own Rack-based frameworks in their own folders under lib/, putting your classes (which sub-class your favorite framework) under the main module (by default, it's called Project). Then, update config.ru and you're good to go!

Development

  • Run rake or rake help to see available tasks

  • Insert binding.pry anywhere in your code to invoke the Pry REPL, which you can use for debugging purposes.

  • There's simple logging and an example of a Capybara test you can look at in this template.

  • protip: remove deleted files from Git (commit the deletions) by doing: git ls-files --deleted | xargs git rm

  • protip: remember to run gem binaries (like Pry or Foreman) with bundle exec so that Bundler knows to take the path to your local gems in vendor/ruby

Thanks

The original fork of this project came from https://github.com/daddz/sinatra-rspec-bundler-template, who in turn credits the Padrino team greatly.

Something went wrong with that request. Please try again.