Code Monkey home page Code Monkey logo

administrate's Introduction

Administrate

Circle CI Gem Version Code Climate

A Rails engine that helps you put together a super-flexible admin dashboard. Try the demo.

Note: Administrate is still pre-1.0, and there may be occasional breaking changes to the API.

administrate

Guiding Principles

Administrate is heavily inspired by projects like Rails Admin and ActiveAdmin, but aims to provide a better user experience for site admins, and to be easier for developers to customize.

To do that, Administrate follows a few simple rules:

  • No DSLs (domain-specific languages)
  • Support the simplest use cases, and let the user override defaults with standard tools such as plain Rails controllers and views.
  • Break up the library into core components and plugins, so each component stays small and easy to maintain.

Getting Started

Add Administrate to your Gemfile:

# Gemfile
gem "administrate", "~> 0.1.1"

Re-bundle, then run the installer:

$ rails generate administrate:install

Restart your server, and visit http://localhost:3000/admin to see your new dashboard in action.

To customize the appearance, behavior, and contents of the dashboard, see the guides at http://administrate-docs.herokuapp.com.

Repository Structure

This repository contains both the source code for Administrate, and a demo Rails app that uses Administrate. The demo app is hosted publicly on Heroku.

  • The gem's source code lives in the administrate subdirectory.
  • The demo app is at the repository root, in order to support deployment on Heroku.

With this structure, developing a typical feature looks like:

  • Add tests in spec/
  • Implement a feature in administrate/
  • Exercise the feature using the root-level rails app (app/)

Contributing Guidelines

Use the following guides for getting things done, programming well, and programming in style.

administrate's People

Contributors

c-lliope avatar danbee avatar jayroh avatar 5minpause avatar mgrachev avatar damirsvrtan avatar croaky avatar picandocodigo avatar franzejr avatar tonytonyjan avatar julienitard avatar fx avatar olivierlacan avatar pusewicz avatar smharley avatar doabit avatar

Stargazers

Cornelius Denninger avatar

Watchers

Mark Dillon avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.