billgloff / upmin-admin-ruby

Framework for creating powerful admin backends with minimal effort in Ruby on Rails.

Upmin Admin

Upmin Admin is a framework for creating powerful admin backends with minimal effort.

Demo Videos

NOTE - The videos are currently outdated, and are only relevant for versions below 0.1.0. Please refer to the docs for recent releases until we get them updated.

To see videos showing how to install and giving a pretty good overview of the main features of upmin-admin go to https://www.upmin.com/admin-rails.

Demo Applications

There is also a demo application you can test out here: store_demo. The repository is maintained and updated by Upmin, but you are welcome to contribute to it.

If you do choose to use the store_demo, please follow the directions in the README to ensure you have seed data to work with.

You can also generate a starter application using Rails Composer that sets up Devise, role-based authorization, and upmin-admin. See Upmin Admin Interface in Rails Composer.

Installation

Installing upmin-admin is incredibly easy. Simple add the gem to your Gemfile:

gem 'upmin-admin'

And then mount the engine in your routes.rb file:

mount Upmin::Engine => '/admin'

If you already have routes pointing to /admin you can use any path you want, for example you could use the following instead:

mount Upmin::Engine => '/ice-ice-baby'

And you would access your admin page at localhost:3000/ice-ice-baby or yoursite.com/ice-ice-baby.

Rails 4.2

Add the following to your gemfile:

gem 'ransack', github: 'activerecord-hackery/ransack', branch: 'rails-4.2'

upmin-admin currently depends on ransack, and you need to use the 4.2 branch of ransack due to changes in ActiveRecord.

Documentation

For further documentation, please visit our Wiki. The docs there are far from complete, but we are actively updating them. If you have any trouble or can't find the documentation to do something please create an issue and contribute to the docs where you can.

Going Forward

Upmin Admin is new. It has been live for less than a few months, so there are going to be things missing. If you want to make it better, get involved and create issues when you find bugs or want new features, and contribute with pull requests.

The major features that are being worked on now are:

1. Mongoid support
2. Fixing bugs as we find them
3. Adding widgets
4. Implementing the dashboard

Support & Feedback

We are always looking for feedback and suggestions. We prefer that you create a GitHub issue, but you can use any of the following to contact us:

Email - [e-mail]

Twitter - @UpminSupport

GitHub - Create an Issue

Please note that this is an open source project, and we can't always respond immediately, but we do try to respond to all inquiries within 24 hours and are usually much faster to respond.