Sha256: abe7ae88af502aff8ed871c72d8f2cfdfe692691cf02482e90b618a2441f3729

Contents?: true

Size: 1.93 KB

Versions: 6

Compression:

Stored size: 1.93 KB

Contents

Spud Core Admin
===============

Spud Admin is a dependency package that adds a nice looking administrative panel to any project you add it to with built in authlogic authentication ready to go out of the box. It supports easy engine integration and there are several planned future engines that we plan on designing for the spud suite. The first of which is Spud CMS which can be found at http://github.com/davydotcom/spud_cms

Installation/Usage
------------------

1. In your Gemfile add the following

		gem 'tb_core'

2. Run bundle install
3. Copy in database migrations to your new rails project

		bundle exec rake tb_core:install:migrations
		rake db:migrate

4. run a rails server instance and point your browser to /spud/admin


Adding Your Own Engines
-----------------------

Creating a rails engine that ties into spud admin is fairly straight forward
In your new engine add spud_admin as a dependency and create an initializer inside your engine class as such:

		initializer :admin do
			Spud::Core.configure do |config|
			config.admin_applications += [{:name => "Pages",:thumbnail => "spud/admin/pages_thumb.png",:url => "/spud/admin/pages",:order => 0}]

			end
		end

You can use the layouts provided with spud admin by using 'spud/admin/application' or 'spud/admin/detail' layouts

When creating controllers for the admin panel create them in the Spud::Admin Namespace and have them extend Spud::Admin::ApplicationController for automatic user authentication restrictions.

Testing
-----------------

Spud uses RSpec for testing. Get the tests running with a few short commands:

1. Create and migrate the databases:
   
		rake db:create
		rake db:migrate

2. Load the schema in to the test database:

		rake app:db:test:prepare

3. Run the tests with RSpec

		rspec spec

After the tests have completed the current code coverage stats is available by opening ```/coverage/index.html``` in a browser.


NOTE: Spud Core is Retina Resolution Compatible Now

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
tb_core-1.0.2 README.markdown
tb_core-1.0.1 README.markdown
tb_core-1.0 README.markdown
tb_core-0.9.19 README.markdown
tb_core-0.9.18 README.markdown
tb_core-0.9.17 README.markdown