# typus

**Repository Path**: mirrors_kikito/typus

## Basic Information

- **Project Name**: typus
- **Description**: Ruby on Rails control panel to allow trusted users edit structured content.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Typus: Admin Panel for Ruby on Rails applications

[![Build Status](https://travis-ci.org/typus/typus.svg?branch=master)](https://travis-ci.org/typus/typus)
[![Circle CI](https://circleci.com/gh/typus/typus/tree/master.svg?style=svg)](https://circleci.com/gh/typus/typus/tree/master)

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

![Main Dashboard](http://i.imgur.com/88oInjS.png?1)

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][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][paperclip] and [dragonfly][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][issues] 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][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

- [Documentation](http://docs.typuscmf.com/)
- [RubyGems][typus_gem]
- [Contributors List](http://github.com/typus/typus/contributors)


## License

**Typus** is released under the MIT license.

[typus]: http://github.com/typus/typus
[typus_demo]: http://demo.typuscmf.com/
[typus_locales]: https://github.com/typus/typus/tree/master/config/locales
[typus_gem]: http://rubygems.org/gems/typus
[paperclip]: http://rubygems.org/gems/paperclip
[dragonfly]: http://rubygems.org/gems/dragonfly
[rails]: http://rubyonrails.org/
[gist]: https://gist.github.com/
[issues]: https://github.com/typus/typus/issues
[kaminari]: http://rubygems.org/gems/kaminari
[will_paginate]: http://rubygems.org/gems/will_paginate