argon_admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c891dd162a61bb9d0299259487d9e036afb9ef0761d035754b1d335a5a28a236
+  data.tar.gz: c110fe882dd220994e113ca3ad6c39bd14044eca9e25e4d975d74cfcf47ae740
+SHA512:
+  metadata.gz: 84dbafd0b95268146559cf6155c01a2ed9fc146ffa0438a9d72124fc975b933acc6bac9c1d5431b1aab86aff4525bff9b24677de5258c2fbaf73180f7b63432b
+  data.tar.gz: b230a0608f55b2e54de1e5eb2fc93f872f1ef8af690c943796f87555a370b998ccbb8b109e56ba461f4e00153fca24559b5482f35212009ffc82e6d95ee5a00f

data/README.md

@@ -0,0 +1,42 @@
+# ArgonAdmin
+
+Simple admin panel generator with the [Argon Dashboard theme](https://github.com/creativetimofficial/argon-dashboard) for your new project.
+
+![](https://i.ibb.co/DGHc4Q0/argon-dashboard.jpg)
+
+Main features included by default:
+
+- Authentication with [Devise](https://github.com/plataformatec/devise).
+- [Argon Dashboard theme](https://github.com/creativetimofficial/argon-dashboard) theme included for the admin panel.
+- ERB template engine.
+- Pagination with [Kaminari](https://github.com/kaminari/kaminari)
+- [Simple form](https://github.com/plataformatec/simple_form) integration
+- Сustomized flash messages
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'argon_admin'
+```
+And then execute:
+
+    $ bundle i
+    
+Next, you need to run the generator:
+
+    $ rails argon_admin:install
+    
+Generate devise user:
+
+    $ rails db:migrate
+    $ rails db:seed
+    
+And you're ready to go. Test if all it's ok by starting a server and check it with rails s.
+
+Default admin user with email admin@example.com and password 123456789
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zelen-sv/argon_admin.

data/lib/argon_admin.rb

@@ -0,0 +1,7 @@
+require "argon_admin/version"
+
+module ArgonAdmin
+  module Rails
+    require "argon_admin/engine"
+  end
+end

data/lib/argon_admin/engine.rb

@@ -0,0 +1,8 @@
+class Engine < ::Rails::Engine
+  require "jquery-rails"
+  require "bootstrap"
+  require "font-awesome-rails"
+  require "devise"
+  require "simple_form"
+  require "kaminari"
+end

data/lib/argon_admin/version.rb

@@ -0,0 +1,3 @@
+module ArgonAdmin
+  VERSION = "0.1.0"
+end

data/lib/generators/argon_admin_generator.rb

@@ -0,0 +1,83 @@
+class ArgonAdminGenerator < Rails::Generators::Base
+  include Singleton
+  source_root File.expand_path("../templates", __dir__)
+
+  ROUTES_TEXT = <<-RUBY
+  namespace :admin do
+    root 'pages#dashboard'
+    resources :users
+  end
+  RUBY
+
+  HELPER_TEXT = <<-RUBY
+  def flash_class(level)
+    case level.to_sym
+        when :notice then "alert alert-primary"
+        when :success then "alert alert-success"
+        when :error then "alert alert-danger"
+        when :alert then "alert alert-warning"
+    end
+  end
+  RUBY
+
+  ASSETS_TEXT = <<-RUBY
+  Rails.application.config.assets.precompile += %w( admin.js admin.scss )
+  Rails.application.config.assets.precompile << /\.(?:svg|eot|woff|ttf)\z/
+  RUBY
+
+  def generate_assets
+    copy_file "assets/stylesheets/admin.scss", "app/assets/stylesheets/admin.scss"
+    copy_file "assets/javascripts/admin.js", "app/assets/javascripts/admin.js"
+    directory "assets/images/admin", "app/assets/images/admin"
+    append_to_file 'config/initializers/assets.rb' do
+      ASSETS_TEXT
+    end
+  end
+
+  def generate_views
+    directory "layouts", "app/views/layouts"
+    directory "views/pages", "app/views/admin/pages"
+    directory "views/users", "app/views/admin/users"
+    directory "views/shared", "app/views/admin/shared"
+    directory "views/sessions", "app/views/devise/sessions"
+    directory "views/kaminari", "app/views/kaminari"
+  end
+
+  def generate_admin_data
+    insert_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do
+      ROUTES_TEXT
+    end
+    insert_into_file "app/helpers/application_helper.rb", after: "module ApplicationHelper\n" do
+      HELPER_TEXT
+    end
+    directory "controllers", "app/controllers/admin/"
+  end
+
+  def generate_devise_data
+    add_secret_key
+    update_development_mailer_config
+    update_seeds_file
+  end
+
+  private
+
+  def add_secret_key
+    secret = SecureRandom.hex(64)
+    insert_into_file "config/initializers/devise.rb", after: "Devise.setup do |config|\n" do
+      "config.secret_key = '#{secret}'"
+    end
+    gsub_file('config/initializers/devise.rb', "config.sign_out_via = :delete", "config.sign_out_via = :get")
+  end
+
+  def update_development_mailer_config
+    insert_into_file "config/environments/development.rb", after: "Rails.application.configure do\n" do
+      "config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }\n"
+    end
+  end
+
+  def update_seeds_file
+    append_to_file 'db/seeds.rb' do
+      "User.create!(email: 'admin@example.com', password: '123456789', password_confirmation: '123456789')"
+    end
+  end
+end

data/lib/tasks/argon_admin_tasks.rake

@@ -0,0 +1,15 @@
+require 'generators/argon_admin_generator'
+
+namespace :argon_admin do
+  desc 'Generate admin panel'
+  task :install do
+    generator = ArgonAdminGenerator.instance
+    generator.generate_assets
+    generator.generate_views
+    generator.generate_admin_data
+    system "rails generate simple_form:install --bootstrap"
+    system "rails generate devise:install"
+    generator.generate_devise_data
+    system "rails generate devise user"
+  end
+end

data/lib/templates/assets/javascripts/admin.js

@@ -0,0 +1,5 @@
+//= require jquery
+//= require jquery_ujs
+//= require popper
+//= require bootstrap-sprockets
+//= require argon-admin

data/lib/templates/assets/stylesheets/admin.scss

@@ -0,0 +1,4 @@
+@import "bootstrap";
+@import "nucleo";
+@import "font-awesome";
+@import "argon-admin";

data/lib/templates/controllers/base_admin_controller.rb

@@ -0,0 +1,4 @@
+class Admin::BaseAdminController < ApplicationController
+  layout 'admin'
+  before_action :authenticate_user!
+end

data/lib/templates/controllers/pages_controller.rb

@@ -0,0 +1,4 @@
+class Admin::PagesController < Admin::BaseAdminController
+  def dashboard
+  end
+end

data/lib/templates/controllers/users_controller.rb

@@ -0,0 +1,44 @@
+class Admin::UsersController < Admin::BaseAdminController
+  before_action :set_user, only: [:edit, :update, :destroy]
+
+  def new
+    @user = User.new
+  end
+
+  def index
+    @users = User.order(created_at: :desc).page(params[:page]).per(6)
+  end
+
+  def edit
+  end
+
+  def update
+    return redirect_to admin_users_path if @user.update(user_params)
+    flash.now[:error] = 'Failed to update user!'
+    render 'edit'
+  end
+
+  def create
+    @user = User.new(user_params)
+
+    return redirect_to admin_users_path if @user.save
+    flash.now[:error] = 'Failed to create user!'
+    render 'new'
+  end
+
+  def destroy
+    @user.destroy
+    flash[:error] = 'User destroyed'
+    redirect_to admin_users_path
+  end
+
+  private
+
+  def set_user
+    @user = User.find(params[:id])
+  end
+
+  def user_params
+    params.require(:user).permit(:email, :password, :password_confirmation)
+  end
+end

data/lib/templates/layouts/admin.html.erb

@@ -0,0 +1,26 @@
+<!doctype html>
+<html class="no-js h-100">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <title>Admin panel</title>
+
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700" rel="stylesheet">
+
+    <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag 'admin', media: 'all', 'data-turbolinks-track': 'reload' %>
+  </head>
+  <body>
+    <%= render 'admin/shared/sidebar' %>
+    <div class="main-content">
+      <%= render 'admin/shared/navbar' %>
+      <%= render 'admin/shared/header' %>
+      <div class="container-fluid mt--7">
+        <%= render 'admin/shared/alert' %>
+        <%= yield %>
+        <%= render 'admin/shared/footer' %>
+      </div>
+    </div>
+  </body>
+  <%= javascript_include_tag 'admin' %>
+</html>

data/lib/templates/layouts/devise.html.erb

@@ -0,0 +1,26 @@
+<!doctype html>
+<html class="no-js h-100">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <title>Admin panel | Login</title>
+
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700" rel="stylesheet">
+
+    <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag 'admin', media: 'all', 'data-turbolinks-track': 'reload' %>
+  </head>
+  <body class="bg-default">
+    <div class="main-content">
+      <div class="container mt-4 pb-5">
+        <div class="row justify-content-center">
+          <div class="col-lg-5 col-md-7">
+            <%= yield %>
+          </div>
+        </div>
+      </div>
+    </div>
+  </body>
+  <%= javascript_include_tag 'admin' %>
+</html>
+

data/lib/templates/views/kaminari/_gap.html.erb

@@ -0,0 +1 @@
+<span class="page-item gap"><%= "&hellip;".html_safe %></span>

data/lib/templates/views/kaminari/_next_page.html.erb

@@ -0,0 +1,8 @@
+<% unless current_page.last? %>
+<span class="page-item">
+  <%= link_to url, rel: 'next', remote: remote, class: "page-link"  do %>
+    <i class="fa fa-angle-right"></i>
+    <span class="sr-only">Next</span>
+  <% end %>
+</span>
+<% end %>

data/lib/templates/views/kaminari/_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item<%= ' active' if page.current? %>">
+  <%= link_to page, url, {remote: remote, rel: page.rel, class: "page-link"} %>
+</li>

data/lib/templates/views/kaminari/_paginator.html.erb

@@ -0,0 +1,17 @@
+<%= paginator.render do -%>
+  <nav>
+    <ul class="pagination justify-content-end" role="navigation" aria-label="pager">
+      <%= prev_page_tag unless current_page.first? %>
+      <% each_page do |page| -%>
+        <% if page.display_tag? -%>
+          <%= page_tag page %>
+        <% elsif !page.was_truncated? -%>
+          <%= gap_tag %>
+        <% end -%>
+      <% end -%>
+      <% unless current_page.out_of_range? %>
+        <%= next_page_tag unless current_page.last? %>
+      <% end %>
+    </ul>
+  </nav>
+<% end -%>

data/lib/templates/views/kaminari/_prev_page.html.erb

@@ -0,0 +1,8 @@
+<% unless current_page.first? %>
+<span class="page-item">
+  <%= link_to url, rel: 'prev', remote: remote, class: "page-link"  do %>
+    <i class="fa fa-angle-left"></i>
+    <span class="sr-only">Previous</span>
+  <% end %>
+</span>
+<% end %>

data/lib/templates/views/pages/dashboard.html.erb

@@ -0,0 +1,228 @@
+<% content_for :header_body do %>
+  <div class="container">
+    <div class="col-lg-7 col-md-10">
+      <h1 class="display-2 text-white">Hello Admin</h1>
+      <p class="text-white mt-0 mb-5">This is your dashboard page.</p>
+    </div>
+  </div>
+<% end %>
+
+<div class="row">
+  <div class="col">
+    <div class="card shadow">
+      <div class="card-header border-0">
+        <h3 class="mb-0">Example projects table</h3>
+      </div>
+      <div class="table-responsive">
+        <table class="table align-items-center table-flush">
+          <thead class="thead-light">
+            <tr>
+              <th scope="col">Project</th>
+              <th scope="col">Budget</th>
+              <th scope="col">Status</th>
+              <th scope="col">Completion</th>
+              <th scope="col">Actions</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <th scope="row">
+                <div class="media align-items-center">
+                  <div class="media-body">
+                    <span class="mb-0 text-sm">Project №1</span>
+                  </div>
+                </div>
+              </th>
+              <td>
+                $2,500 USD
+              </td>
+              <td>
+                <span class="badge badge-dot mr-4">
+                  <i class="bg-warning"></i> pending
+                </span>
+              </td>
+              <td>
+                <div class="d-flex align-items-center">
+                  <span class="mr-2">60%</span>
+                  <div>
+                    <div class="progress">
+                      <div class="progress-bar bg-warning" role="progressbar" aria-valuenow="60" aria-valuemin="0" aria-valuemax="100" style="width: 60%;"></div>
+                    </div>
+                  </div>
+                </div>
+              </td>
+              <td class="text-right">
+                <div class="dropdown">
+                  <a class="btn btn-sm btn-icon-only text-light" href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                    <i class="fa fa-ellipsis-v"></i>
+                  </a>
+                  <div class="dropdown-menu dropdown-menu-right dropdown-menu-arrow">
+                    <a class="dropdown-item" href="#">Action</a>
+                    <a class="dropdown-item" href="#">Another action</a>
+                    <a class="dropdown-item" href="#">Something else here</a>
+                  </div>
+                </div>
+              </td>
+            </tr>
+            <tr>
+              <th scope="row">
+                <div class="media align-items-center">
+                  <div class="media-body">
+                    <span class="mb-0 text-sm">Project №2</span>
+                  </div>
+                </div>
+              </th>
+              <td>
+                $1,800 USD
+              </td>
+              <td>
+                <span class="badge badge-dot">
+                  <i class="bg-success"></i> completed
+                </span>
+              </td>
+              <td>
+                <div class="d-flex align-items-center">
+                  <span class="mr-2">100%</span>
+                  <div>
+                    <div class="progress">
+                      <div class="progress-bar bg-success" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%;"></div>
+                    </div>
+                  </div>
+                </div>
+              </td>
+              <td class="text-right">
+                <div class="dropdown">
+                  <a class="btn btn-sm btn-icon-only text-light" href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                    <i class="fa fa-ellipsis-v"></i>
+                  </a>
+                  <div class="dropdown-menu dropdown-menu-right dropdown-menu-arrow">
+                    <a class="dropdown-item" href="#">Action</a>
+                    <a class="dropdown-item" href="#">Another action</a>
+                    <a class="dropdown-item" href="#">Something else here</a>
+                  </div>
+                </div>
+              </td>
+            </tr>
+            <tr>
+              <th scope="row">
+                <div class="media align-items-center">
+                  <div class="media-body">
+                    <span class="mb-0 text-sm">Project №3</span>
+                  </div>
+                </div>
+              </th>
+              <td>
+                $3,150 USD
+              </td>
+              <td>
+                <span class="badge badge-dot mr-4">
+                  <i class="bg-danger"></i> delayed
+                </span>
+              </td>
+              <td>
+                <div class="d-flex align-items-center">
+                  <span class="mr-2">73%</span>
+                  <div>
+                    <div class="progress">
+                      <div class="progress-bar bg-danger" role="progressbar" aria-valuenow="73" aria-valuemin="0" aria-valuemax="100" style="width: 73%;"></div>
+                    </div>
+                  </div>
+                </div>
+              </td>
+              <td class="text-right">
+                <div class="dropdown">
+                  <a class="btn btn-sm btn-icon-only text-light" href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                    <i class="fa fa-ellipsis-v"></i>
+                  </a>
+                  <div class="dropdown-menu dropdown-menu-right dropdown-menu-arrow">
+                    <a class="dropdown-item" href="#">Action</a>
+                    <a class="dropdown-item" href="#">Another action</a>
+                    <a class="dropdown-item" href="#">Something else here</a>
+                  </div>
+                </div>
+              </td>
+            </tr>
+            <tr>
+              <th scope="row">
+                <div class="media align-items-center">
+                  <div class="media-body">
+                    <span class="mb-0 text-sm">Project №4</span>
+                  </div>
+                </div>
+              </th>
+              <td>
+                $4,400 USD
+              </td>
+              <td>
+                <span class="badge badge-dot">
+                  <i class="bg-info"></i> on schedule
+                </span>
+              </td>
+              <td>
+                <div class="d-flex align-items-center">
+                  <span class="mr-2">90%</span>
+                  <div>
+                    <div class="progress">
+                      <div class="progress-bar bg-info" role="progressbar" aria-valuenow="90" aria-valuemin="0" aria-valuemax="100" style="width: 90%;"></div>
+                    </div>
+                  </div>
+                </div>
+              </td>
+              <td class="text-right">
+                <div class="dropdown">
+                  <a class="btn btn-sm btn-icon-only text-light" href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                    <i class="fa fa-ellipsis-v"></i>
+                  </a>
+                  <div class="dropdown-menu dropdown-menu-right dropdown-menu-arrow">
+                    <a class="dropdown-item" href="#">Action</a>
+                    <a class="dropdown-item" href="#">Another action</a>
+                    <a class="dropdown-item" href="#">Something else here</a>
+                  </div>
+                </div>
+              </td>
+            </tr>
+            <tr>
+              <th scope="row">
+                <div class="media align-items-center">
+                  <div class="media-body">
+                    <span class="mb-0 text-sm">Project №5</span>
+                  </div>
+                </div>
+              </th>
+              <td>
+                $2,200 USD
+              </td>
+              <td>
+                <span class="badge badge-dot mr-4">
+                  <i class="bg-success"></i> completed
+                </span>
+              </td>
+              <td>
+                <div class="d-flex align-items-center">
+                  <span class="mr-2">100%</span>
+                  <div>
+                    <div class="progress">
+                      <div class="progress-bar bg-success" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%;"></div>
+                    </div>
+                  </div>
+                </div>
+              </td>
+              <td class="text-right">
+                <div class="dropdown">
+                  <a class="btn btn-sm btn-icon-only text-light" href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                    <i class="fa fa-ellipsis-v"></i>
+                  </a>
+                  <div class="dropdown-menu dropdown-menu-right dropdown-menu-arrow">
+                    <a class="dropdown-item" href="#">Action</a>
+                    <a class="dropdown-item" href="#">Another action</a>
+                    <a class="dropdown-item" href="#">Something else here</a>
+                  </div>
+                </div>
+              </td>
+            </tr>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+</div>