Skip to content

setup_with_wulin_gems.md

Latest commit

 

History

History
144 lines (79 loc) · 3.57 KB

setup_with_wulin_gems.md

File metadata and controls

144 lines (79 loc) · 3.57 KB

#Setup a new application with Wulin gems

##Setup WulinMaster

###Install

Put 'gem wulin_master' to your Gemfile, and run bundle command to install it:

gem 'wulin_master'

###1.Run rails g wulin_master:install generator

rails g wulin_master:install

It will:

create  app/controllers/homepage_controller.rb # All menu will config in this file
create  config/initializers/wulin_master.rb    # Some global configurations will localed in this file
 route  root :to => 'homepage#index'           # Set the homepage route

###2.Remove origin files of Rails app

For apply WulinMaster layout, you need to remove two origin files of Rails app

rm public/index.html
rm app/views/layouts/application.html.erb   # WulinMaster provide a beautful layout template already

Then start you app and visit it, you will look at the initialized homepage with a example menu.

###3.Remove Jquery lib require

Remve jquery and jquery_ujs require in application.js

//= require jquery
//= require jquery_ujs

###4.Create a new screen and grid

WulinMaster provide a generator to generate screen and grid.

rails g wulin_master:screen_and_grid Post title content:text

##Setup WulinOauth

Install

GridState for current user was supported. but first, you must have current_user.

You can use you own authentication process, and also can use WulinOauth.

Put 'gem wulin_oauth' to your Gemfile, and run bundle command to install it:

  gem 'wulin_oauth'

And then create wulin_oauth.yml config file under config folder.Please check WulinOauth documents.

###Config

Put some code for wulin_oauth in application_controller.rb

#app/controllers/application_controller.rb
before_action :require_login
before_action :set_current_user

def set_current_user
  User.set_current_user(current_user)
end

##Enabled GridState

Run generator to create migrate file of grid_state modle:

rails g wulin_master:grid_states

And then run rake db:migrate to create grid_states table.

##Setup WulinExcel

What you need to do is put 'gem wulin_excel' to your Gemfile, and run bundle command to install it:

gem 'wulin_excel'

then you can export grid with excel file.

##Setup WulinPermits

WulinPermits add some extensions to WulinMaster to implement

###Install

Put 'gem wulin_permits' to your Gemfile, and run bundle command to install it:

gem 'wulin_permits'

Then run rake to copy migrate files to app/db/migrate folder:

rake wulin_permits_engine:install:migrations

Then run rake db:migrate to create tables for it.

###Add menus

You need add user and role menu to homepage_controller.rb:

# app/controllers/homepage_controller.rb
submenu 'Settings' do
  item UserScreen
  item RoleScreen
end

###Load existing permissions to database

Run rake to load existing permissions to database every time you create new grid.

rake wulin_permits:load_permissions

##Setup WulinAudit

###Install

Put 'gem wulin_audit' to your Gemfile, and run bundle command to install it:

gem 'wulin_audit'

###Config mongoid

WulinAudit is base on Mongoid. So before we use it, we need make sure mongid is working.

Create mongoid config file:

rails g mongoid:config

and config mongo in it.

###Add menu

You can add global audit screen link to menu:

# app/controllers/homepage_controller.rb
submenu 'Settings' do
  item AuditLogScreen
end