Rails application generator that builds a new project skeleton configured with Carbon Five preferences and best practices baked right in. Spend less time configuring and more building cool features.
Major tools/libraries:
- Rails
- PostgreSQL
- Slim
- Less
- Bootstrap
- Sorcery
- Cancan
- RSpec
- Factory Girl
- Jasmine
- SimpleCov
- Guard (rspec, jasmine, livereload)
- And many tweaks, patterns and common recipes.
Raygun includes generator templates for controllers, views, and specs so that generated code follows best practices. For example, view generation produces bootstrap compatible markup and rspec specs use factory girl when appropriate.
Inspired by Xavier Shay and ThoughtBot's Suspenders. Thanks!
Raygun...
- Generates a new rails application that's ready for immediate feature development.
- Generates an application that has best practices that apply to most projects baked in.
- Generates an application that includes specs for all build in functionality.
- Is a forum for discussing what should or should not be included as part of a standard stack.
$ gem install raygun
To generate an application, you only need the raygun gem.
To run your new application's specs or fire up its server, you'll need to meet these requirements.
- PostgreSQL 9.x with superuser 'postgres' with no password (
createuser -s postgres) - PhantomJS for JavaScript testing (
brew install phantomjs)
The generated app will be configured to use the ruby version that was used to invoke raygun. If you're using
another ruby, just change the Gemfile and .ruby-version as necessary.
$ raygun your-project
Once your project is baked out, you can easily kick the wheels. Be sure that you have the prerequities covered (see above).
$ cd your-project
$ gem install bundler
$ bundle update
# Prepare the database: schema and reference / sample data
$ rake db:setup db:sample_data
# Run the specs
$ rake
# Fire up the app and open it in a browser
$ foreman start
$ open http://0.0.0.0:3000
Raygun simply copies the rails_32 tree and then runs a small set of commands to customize the copied project. So, what you get looks a lot like rails_32. Check out raygun to see how it's massaged after being copied.
This approach is fast, simple, and makes raygun developement very easy. Make changes to rails_32, run its specs and fire up the server to see what happens.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Generate an example app using your local development version of raygun:
$ ./bin/raygun tmp/example_app