File: README — Documentation for angularjs-on-rails (0.1.2)

AngularJS on Rails

wraps the AngularJS 1.2.21 library for use in Rails 3.x and above. This project is an application skeleton for a typical AngularJS web app. You can use it to quickly bootstrap your angular webapp projects.

Installation

In your Gemfile, add this line:

gem 'angularjs-on-rails'

Then run the following commands:

bundle install
rails g angular:install

Angular App Structure

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

|-- app_name.coffee
|-- index.html
|   |-- controllers/
|       |-- app_name-controller.coffee
|   |-- directives/
|       |-- app_name-directive.coffee
|   |-- filters/
|       |-- app_name-filter.coffee
|   |-- services
|       |-- app_name-service.coffee
|   |-- styles
|   |-- views

Add's the following directive's to your JavaScript manifest file (application.js):

//= require angular
//= require angular/app_name

If you desire to require (optional) Angular files, you may include them as well in your JavaScript manifest file (application.js). For example:

//= require angular-animate
//= require angular-resource

If you want to Skip Git ignores and keeps

rails g angular:install -G

Best Practice Recommendations for Angular App Structure

AngularJS vs. Turbolinks

Turbolinks as well as AnguluarJS can both be used to make a web application respond faster, in the sense that in response to a user interaction something happens on the web page without reloading and rerendering the whole page.

They differ in the following regard:

AngularJS helps you to build a rich client-side application, where you write a lot of JavaScript code that runs on the client machine. This code makes the site interactive to the user. It communicates with the server-side backend, i.e. with the Rails app, using a JSON API.

Turbolinks, on the other hand, helps to to make the site interactive without requiring you to code JavaScript. It allows you to stick to the Ruby/Rails code run on the server-side and still, "magically", use AJAX to replace, and therefore rerender, only the parts of the page that have changed.

Where Turbolinks is strong in allowing you use this powerful AJAX mechanism without doing anything by hand and just code Ruby/Rails, there might come a stage, as your application grows, where you would like to integrate a JavaScript framework such as AngularJS.

Especially in this intermedium stage, where you would like to successively integrate AngularJS into your application, one component at a time, it can make perfectly sense to run Angular JS and Turbolinks together.

..more

Contributing to AngularJS on Rails

Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
Fork the project.
Start a feature/bugfix branch.
Commit and push until you are happy with your contribution.
Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

About us

Optisol Business Solutions