Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 3.23 KB

README.md

File metadata and controls

105 lines (71 loc) · 3.23 KB
Raw

Typus: Admin Panel for Ruby on Rails applications

Typus is a control panel for Ruby on Rails applications to allow trusted users edit structured content.

It’s not a CMS with a full working system but it provides a part of the system: authentication, permissions and basic look and feel for your websites control panel. So using Rails with Typus lets you concentrate on your application instead of the bits to manage the system.

Typus is the "old latin" word for type which stands for:

A category of people or things having common characteristics.

Main View

You can try a demo here.

Key Features

  • Built-in Authentication and Access Control Lists.
  • CRUD and custom actions for your models on a clean interface.
  • Internationalized interface (See available translations)
  • Customizable and extensible templates.
  • Integrated paperclip and dragonfly attachments viewer.
  • Support for Kamaniri and WillPaginate.
  • Works with Rails 3.2.X.

Installing

Add Typus to your Gemfile:

gem 'typus'

# Bundle edge Typus instead:
# gem 'typus', :git => 'git://github.com/fesplugas/typus.git'

Update your bundle, run the generator and start the application server:

$ bundle install
$ rails generate typus
$ rails server

and go to http://0.0.0.0:3000/admin.

Testing

Build Status

Create a PostgreSQL database:

$ psql -c 'CREATE USER postgres SUPERUSER' -d postgres
$ psql -c 'CREATE DATABASE typus_test;' -U postgres

To test, clone the repo and run the following commands:

$ git clone git://github.com/fesplugas/typus.git
$ bundle install --path vendor/bundle
$ bundle exec rake

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Links

License

Typus is released under the MIT license.