#thorax-rails

NOTICE: SUPPORT FOR THIS PROJECT HAS ENDED

This projected was owned and maintained by Walmart. This project has reached its end of life and Walmart no longer supports this project.

We will no longer be monitoring the issues for this project or reviewing pull requests. You are free to continue using this project under the license terms or forks of this project at your own risk. This project is no longer subject to Walmart's bug bounty program or other security monitoring.

We recommend you take the following action:

• Review any configuration files used for build automation and make appropriate updates to remove or replace this project
• Notify other members of your team and/or organization of this change
• Notify your security team to help you evaluate alternative options

For security reasons, Walmart does not transfer the ownership of our primary repos on Github or other platforms to other individuals/organizations. Further, we do not transfer ownership of packages for public package management systems.

If you would like to fork this package and continue development, you should choose a new name for the project and create your own packages, build automation, etc.

Please review the licensing terms of this project, which continue to be in effect even after decommission.

The thorax gem includes Thorax.js and its dependencies (backbone, underscore, and handlebars) in your Rails asset pipeline. A few handy generators take care the boilerplate code so you don't have to. Enjoy!

This gem requires the use of rails 3.1 and greater, coffeescript and the new rails asset pipeline provided by sprockets.

In your Gemfile, add this line:

gem "thorax-rails", "~> 0.1.0"

Then run the following commands:

bundle install
rails g thorax:install

Running rails g thorax:install will create the following directory structure under app/assets/javascripts/:

models/
collections/
routers/
templates/
views/

It will also create view, model, collection, and router files that your app will extend. These are great places to define app-wide behaviors.

thorax-rails currently provides 3 simple generators to help get you started using Thorax.js with rails 3.1 and greater. The generators will only create client side code (javascript).

rails g thorax:model ModelName field:type field:type

This generator creates thorax models and collections in app/assets/javascript/models and app/assets/javascripts/collections respectively.

rails g thorax:router ModelName action action

This generator creates a thorax router with corresponding views and templates for the given actions provided.

rails g thorax:view ModelName viewName viewName

This generator creates views and their associated templates

Coming soon! I am currently developing a full CRUD scaffold which will create views and wire up a router for all the RESTful actions for a given model. Watch for version 2!

##Contributing to thorax-rails

This gem is still in development. I would love to hear about any bugs you run into, or tips on how it could be improved. If you would like to contribute directly, please fork the project and start a new branch with a helpful name. Please write tests for your changes.

##Acknowledgments

This gem was written with help from the authors of Thorax, and was heavily influenced by the wonderful backbone-rails gem

##Copyright

Copyright (c) 2013 WalmartLabs. See MIT-LICENSE for further details.