Sha256: 133cb1324b17adb70289d3c20693e8bda87c6300d8e275d88bd4746d63941728

Contents?: true

Size: 1.66 KB

Versions: 16

Compression:

Stored size: 1.66 KB

Contents

# TKH Admin Panel

This is a Rails engine with an admin panel layout, assets and basic functionality. Powered by Twitter Bootstrap + SASS for a modern responsive design.

Primarily developed for Ten Thousand Hours but we are happy to share if anybody finds it useful. It's primarily developed to work in sync with the tkh_cms gem suite but over time more and more effort will be made to make it work in isolation.

Please note that this gem is still in its infancy. I'm just getting started. 

## Installation

This gem was created when Rails 3.2.6 was the latest release and there is a railties dependency of "~> 3.2". Add this line to your application's Gemfile:

    gem 'tkh_admin_panel', '~> 0.0'

And then execute:

    $ bundle

Install the admin_sidebar partial

		$ rake tkh_admin_panel:setup
		
Run the migrations
		
		$ rake db:migrate

Start or restart your server!

		$ rails s


## Upgrading

Update the gem:

    $ bundle update tkh_admin_panel

Update locale files.

		$ rake tkh_admin_panel:update
		
Run new migrations if any
		
		$ rake db:migrate

Start or restart your server!

		$ rails s


## Pre-requisite

You need an authentication system with the current_user helper method


## Usage

Add this to your controller's relevant methods:

    switch_to_admin_layout


## Contributing

Pull requests for new features and bug fixes are welcome.

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Create your failing tests based on the Test Unit framework.
4. Create your code which makes the tests pass.
5. Commit your changes (`git commit -am 'Added some feature'`)
6. Push to the branch (`git push origin my-new-feature`)
7. Create new Pull Request

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
tkh_admin_panel-0.9 README.md
tkh_admin_panel-0.3.5 README.md
tkh_admin_panel-0.3.2 README.md
tkh_admin_panel-0.3.1 README.md
tkh_admin_panel-0.3 README.md
tkh_admin_panel-0.2.8 README.md
tkh_admin_panel-0.2.7 README.md
tkh_admin_panel-0.2.6 README.md
tkh_admin_panel-0.2.5.1 README.md
tkh_admin_panel-0.2.5 README.md
tkh_admin_panel-0.2.4.1 README.md
tkh_admin_panel-0.2.4 README.md
tkh_admin_panel-0.2.3 README.md
tkh_admin_panel-0.2.2 README.md
tkh_admin_panel-0.2.1 README.md
tkh_admin_panel-0.2 README.md