README.md in slash_admin-1.3.2 vs README.md in slash_admin-1.3.3

- old
+ new

@@ -1,17 +1,16 @@ <p align="center"> - <img width="250" src="https://i.imgur.com/Rok5Ocf.png" /> + <img width="250" src="https://i.imgur.com/mm9gXtL.png" /> </p> # SlashAdmin [![Gem Version](https://badge.fury.io/rb/slash_admin.svg)](https://badge.fury.io/rb/slash_admin) -[![Code Climate](https://codeclimate.com/github/nicovak/slash_admin/badges/gpa.svg)](https://codeclimate.com/github/nicovak/slash_admin) [![CircleCI](https://circleci.com/gh/nicovak/slash_admin/tree/master.svg?style=svg&circle-token=6e9ebd7fef3ebc881c75a769b0970808024a2ae9)](https://circleci.com/gh/nicovak/slash_admin/tree/master) -A modern and fully overridable admin, just the rails way. -Embeded admin user and authentication system, devise is not needed. +A modern and fully customizable admin, just the rails way. +Embedded admin user and authentication system, devise is not needded. ❤️ [Demo repository](https://github.com/nicovak/slash_admin_demo) 🚀 [Live running](https://slashadmin.herokuapp.com/admin) User @@ -19,11 +18,11 @@ Password `admin@admin` #### Motivation: -- Provide to rails the admin it deserves without DSL or obscure logic. +- Provide to Ruby On Rails the admin it deserves without DSL or obscure logic. - Provide an easy to use and modern experience to final users. I tried to take the best from two greats existing gem: - [rails_admin](https://github.com/sferik/rails_admin) - [administrate](https://github.com/thoughtbot/administrate) @@ -32,41 +31,46 @@ - [keenthemes](http://keenthemes.com/preview/metronic/) #### Screenshots ##### Login -![Image of Login screen](https://i.imgur.com/MJerQSR.jpg) +![Image of Login screen](https://i.imgur.com/ftwC0rF.png) ##### Dashboard -![Image of Dashboard](https://i.imgur.com/0g3wSjw.png) +![Image of Dashboard](https://i.imgur.com/3JzkvoT.png) ##### List -![Image of List](https://i.imgur.com/s1egSS3.png) +![Image of List](https://i.imgur.com/y6Vz6S1.png) ##### Edit / Create -![Image of Create / Edit](https://i.imgur.com/wf72pZz.png) +![Image of Create / Edit](https://i.imgur.com/S2QqHWF.png) ### Installation Add this line to your application's Gemfile: + ```ruby gem 'slash_admin' ``` -And then execute: +Then execute: + ```bash $ bundle install ``` Or install it yourself as: + ```bash $ gem install slash_admin ``` Gemfile + ``` gem 'carrierwave' ``` Then: + ```bash $ rails g slash_admin:install $ rails slash_admin:install:migrations $ rails db:migrate ``` @@ -75,16 +79,39 @@ ```ruby Mime::Type.register "application/xls", :xls ``` +If your apps uses Sprockets 4+, you'll need to add SlashAdmin assets to your `manifest.js` file. To do this, add these two lines to the file: + +`app/assets/config/manifest.js` + +``` +//= link administrate/application.css +//= link administrate/application.js +``` + +`config/routes.rb` + ```ruby Rails.application.routes.draw do mount SlashAdmin::Engine => "/" end ``` -Mounted as '/' but prefixed in the gem and in routes definition of models admin. See above. +Mounted as '/' but prefixed in the gem and in routes definition of models admin. See the full example above. + +```ruby +Rails.application.routes.draw do + mount SlashAdmin::Engine => "/" + + namespace :slash_admin, path: "/admin" do + scope module: 'models' do + resources :pages # assume Page model + end + end +end +``` ### Important If you are using [friendly_id](https://github.com/norman/friendly_id) gem, you have to add `routes: :default` like so: