Dune::Dashboard

What

This is the implementation of Dune's Dashboard. It is built using Ember.js on top of a Rails Engine. It's come from neighborly-dashboard

How

Include this gem as dependency of your project, adding the following line in your Gemfile.

# Gemfile
gem 'dune-dashboard'

Dune::Dashboard is a Rails Engine, integrating with your (Dune) Rails application with very little of effort. To turn the engine on, mount it in an appropriate route:

# config/routes.rb
mount Dune::Dashboard::Engine => '/dashboard/', as: :dune_dashboard

Note that your dune app needs to provide the API for the Dashboard. You can find the dune API here.

Contributing

1. Fork it ( https://github.com/FromUte/dune-dashboard/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Running specs

We prize for our test suite and coverage, so it would be great if you could run the specs to ensure that your patch is not breaking the existing codebase.

$ bundle install

To run the specs just run:

$ bundle exec spec

I18n

We use ember-i18n for internationalization in the Ember application, but we write the translations in a YAML file. To export the translations from YAML to Javascript we have a rake task to do that.

$ bundle exec rake i18n:export

License

Licensed under the MIT license.