Get Shit Done Rails Version

Thanks for trying out Get Shit Done (Rails Version)! We promise your rails app will look awesome after installing it. You can view live preview here.

• Install Preparation
• Installation
• Theme Structure In Rails
• Page Generators
• Changelog
• Copyright

Recommend install on blank new rails app

Although Get Shit Done (Rails Version) can be installed on your existing rails app, we still recommend you to install it on a blank new rails app first and get familiar with how this gem integrates with your rails app.

Remove any bootstrap from existing rails app

If you want to integrate existing rails app, please make sure you have removed all the Bootstrap gems such as twitter-bootstrap-rails, bootstrap-rails, bootstrap-sass, less-rails-bootstrap or any Bootstrap related stylesheets and javascript from your rails app. As Get Shit Done (Rails Version) already contains its own version of Bootstrap.

Back to top

1. Create a new rails application from terminal

rails new exampleapp
cd exampleapp

2. Install gsdk gem

gem 'gsdk', '>= 1.0.0.0'

Run the following command to install the gem:

bundle install

Congratulation, Get Shit Done for Rails Version has been installed on your local machine.

3. Run the install generator to integrate Get Shit Done in your rails app

rails g gsdk:install

The install generator will create the following layout, css and js files in your app:

• app/views/layouts/_base.html.erb
• app/assets/stylesheets/gsdk.css
• app/assets/javascripts/gsdk.js

Also, it added require directive to require gsdk.css and gsdk.js from following manifest files:

• app/assets/stylesheets/application.css
• app/assets/javascripts/application.js

Back to top

Get Shit Done (Rails version) has integrated a lot of the rails best practices such as

• integrate nicely with turbolinks enabled
• dynamic load the javascript init scripts
• proper asset pipeline integration

Before we dive in to using Page Generators. Lets get familiar with how this gem integrates with your rails app

First things first, in order to simplify the file management from your rails app, all the Get Shit Done files are actually located in the gem except the following files for customize purpose:

Get Shit Done files in your rails app folder:

• app/views/layouts/_base.html.erb
• app/assets/stylesheets/gsdk.css
• app/assets/javascripts/gsdk.js

It contains html head and empty body. All other layouts are based on this _base.html.erb layout so that the same html head setting can be reused among different layouts.

There are three yield contents specified in base layout:

<%= yield :style %>
<%= yield :features %>
<%= yield :class %>

You can specify the custom css style content from the view file to fill in this area. For example, if you want to include some style on index view page only. From your index.html.erb, you can specify:

<% content_for :style do %>
<style>
  .somestyle {
  background-color: red;
  }
</style>
<% end %>

You can specify the javascript init features you want to invoke from the view file to fill in this area. For example, if you want to add feature1 and feature2 on index view page only. From your index.html.erb, you can specify:

<% content_for :features, "feature1 feature2" %>

Then add the following init script in gsdk.js OR add it to separate js file and require it from gsdk.js

$(document).on("page:change", function() {
  if ($.inArray('feature1',App.features()) >= 0) {
    Write your feature1 init script here ...
  }
  if ($.inArray('feature2',App.features()) >= 0) {
    Write your feature2 init script here ...
  }
});

You can specify the css class name from the view file to fill in this area. For example, if you want to give the class name on index view page only. From your index.html.erb, you can specify:

<% content_for :class, "home" %>

It is the manifest file using sprockets require directives to require all Get Shit Done stylesheet files.

It is the manifest file using sprockets require directives to require all Get Shit Done javascript files.

Back to top

Get Shit Done comes with the following page generators to help you create the various pages. It automatically handles all setup such as routes, controllers and views. By the way, all view layouts are based on _base.html.erb layout, if you want to use a different layout, you can specify it in your controller.

Generate component view at app/views/CONTROLLER/ACTION

rails g gsdk:components CONTROLLER ACTION

Generate index view at app/views/CONTROLLER/ACTION

rails g gsdk:index CONTROLLER ACTION

Generate navbar transparent view at app/views/CONTROLLER/ACTION

rails g gsdk:navbar_transparent CONTROLLER ACTION

Generate notification view at app/views/CONTROLLER/ACTION

rails g gsdk:notification CONTROLLER ACTION

Generate template view at app/views/CONTROLLER/ACTION

rails g gsdk:template CONTROLLER ACTION

Generate tutorial html view at app/views/CONTROLLER/ACTION

rails g gsdk:tutorial CONTROLLER ACTION

Back to top

2015.10.26 - version 1.4.0.0

• First Release!

Back to top

Design is copyright of Creative Tim. You can purchase the Get Shit Done Pro Rails Version from UiReady

Back to top