jglassenberg/tradeshift-document-downloader

What's Going On?

Rails is magical already, and this package preloads the default Rails 4 setup with plenty of goodies.

Getting Started

1. Add the following to your .env file:

   PORT=3000 RACK_ENV=development

2. Run foreman start and add the line, similar to the line below, to config/initializers/devise.rb:

   config.secret_key = 'd2b22...'

3. Create your heroku app, and push.

Ingredients

1. General Environment Setup
   • Ruby ~> 2.0.0 specified. (Relies on RVM)
2. Tweaks for Heroku support
   • 12factor gem for Build/Deploy support.
   • Sqlite database in development (writes to file), PG for production.
   • • Support for Devise/Heroku/Rails4 that doesn't require you to commit compiled assets to git before pushing.
3. Syntactical sugar
   • HAML for lean HTML templates.
   • • HAMLC / Haml-Coffee-Assets for HAML-based templates (via JST) in Javascript support.
   • SASS for lean stylesheets and mixin support.
   • Coffeescript for lean javascript.
   • Squeel gem for fancy ActiveRecord syntax.
4. Vendored Assets
   • Javascript
     • jQuery
     • Underscore
     • Backbone
     • jQuery.FancyBox 2.0
     • Chosen.js for nice dropdowns.
   • Stylesheets
     • Bootstrap-SASS for including Bootstrap 3 w. SASS source files. (Lets you use SASS mixins)
     • Font Awesome glyph icon set.
5. Test Suite Tools
   • Mocha for stubbing and expectations.
   • [FactoryGirl] for factories instead of fixtures.
     • TODO: All fixtures have been deleted, but maybe modify generators to not create new ones for new models?
     • • Custom callback skipper for skipping before_/after_/save/create callbacks. *
6. Vendored Ruby Tools
   • DelayedJob for background worker queue.
   • Devise for user authentication.
   • OmniAuth and OmniAuth Facebook for O-Auth and Facebook Connect support.
   • make-resourceful for mixing prebuilt RESTful support into your controllers.
   • has-bit-field to add binary flag-type columns to ActiveRecord models.
   • RABL to add a view layer for JSON responses.
     • Includes OJ to avoid a bug in Rails 4 between RABL and the default JSON parser.
   • Paperclip adds support for uploaded files attached to models.
     • Includes [aws-sdk] to support uploading files directly to your Amazon S3 bucket.
       • Keys sourced from environment variables, configured in ./config/application.rb
   • Rails Config provides Settings object, loaded from ./config/settings.yml.
   • rQRCode adds support for generating QR codes in HTML.
   • ActiveAdmin adds support for backend admin panel.

• Custom Things

• vendor/assets/javascript/view_helpers.js.coffee
• assets/javscript/application.js.coffee
  • Backbone includes
  • init.js
  • B