Acceleration application
Ruby JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Fuel-Throttle-Ruby

Fuel-Throttle-Ruby

Fuel Throttle (BETA)

Fuel Throttle is an acceleration project focused on application development using:

  • ExactTarget's HubApps (IMH, Interactive Marketing Hub)
  • Using the Stackato (Fuel Platform's PaaS) infrastructure

The overriding design goal for Fuel Throttle is to reduce the development cycles required to get application code into the Fuel Platform ecosystem.

Version

0.1.0

Technological Goals

Fuel Throttle uses a variety of open source tools to reach its tech. goals:

  • Code@ - ExactTarget's Developer Community
  • Fuel API Family - ExactTarget's RESTful based API ecosystem
  • App Center - ExactTarget's Application Management Interface
  • Fuel UX - The Fuel Platform control library built on Twitter's Bootstrap
  • Stackato - ActiveState's PaaS implemented at ExactTarget
  • Twitter Bootstrap - great UI boilerplate for modern web apps
  • [Ruby] - Server-side scripting language
  • jQuery - duh

System Requirements

Fuel Throttle requires a few components to work from end-to-end:

Installation

  • Ensure your system meets all requirements first

Installation Steps

$ git clone git@github.et.local:Platform/Fuel-Throttle-Ruby.git $ cd TODO: Add string replacements here $ bundle install

  • Open: init.rb, stackato.yml and optionally mongo.yml file.
  • Change the values named "fuelThrottleRuby" to another name of your choosing which is unique to your app

Running Locally

$ rackup config.ru

Running on Stackato Micro Cloud

  • Make sure you've installed the Stackato Micro Cloud and the Stackato client
  • Start the Stackato Micro Cloud VM
  • Make sure you're targeting the correct Stackato environment (our Micro Cloud URL)
  • stackato login
  • stackato push (from within the app's directory)
  • Answer prompts from Stackato where applicable
  • Visit your app's new URL in a browser

Project Roadmap

Fuel Throttle goals will be outlined in the project's milestones on Github.

Known Issues

There are several known issues as this is an organic project, please check the issue list for a complete current state of the project.

Contributing to Fuel Throttle

Contributions are welcomed, to contribute to Fuel Throttle:

  1. Before writing code, we suggest you search for issues or create a new one to confirm where your contribution fits into our roadmap.
  2. Fork the Fuel Throttle repo GitHub help
  3. Make your changes, being sure to add unit tests for new or changed functionality
  4. Update your fork with the latest code from Fuel Throttle, merging as necessary
  5. Commit your changes (using git commit --amend to the original as you progress)
  6. Push to your GitHub repo, using --force if you have rebased
  7. Submit a pull request GitHub help

License

Copyright (c) 2013 ExactTarget, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.