Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Ruby on Rails control panel to allow trusted users edit structured content.
Ruby HTML Other

README.md

Typus: Admin Panel for Ruby on Rails applications

Circle CI

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

Main Dashboard

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.

Key Features

  • Built-in Authentication and Access Control Lists.
  • CRUD and custom actions for your models on a clean interface.
  • Customizable and extensible templates.
  • Integrated paperclip and dragonfly attachments viewer.
  • Supports Rails 4

Installing

Add Typus to your Gemfile.

If you are using Rails 4.1 or Rails 4.2:

gem "typus", github: "typus/typus"

If you are using Rails 4.0:

gem "typus", github: "typus/typus", branch: "4-0-stable"

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

To test, clone the repo and run:

git clone git://github.com/typus/typus.git
./bin/run-tests

Running a demo on localhost

To run a demo on localhost:

git clone git://github.com/typus/typus.git
cd test/dummy
./bin/setup
./bin/rails server

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.

Something went wrong with that request. Please try again.