kickster 0.1.2 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/Gemfile +1 -1
- data/README.md +5 -2
- data/bin/kickster +1 -2
- data/kickster.gemspec +7 -4
- data/lib/kickster.rb +6 -2
- data/lib/kickster/generator.rb +5 -46
- data/lib/kickster/install.rb +41 -0
- data/lib/kickster/version.rb +1 -1
- data/template/.ruby-version +1 -1
- data/template/Gemfile +6 -6
- data/template/README.md.tt +26 -0
- data/template/_assets/javascripts/application.js +0 -0
- data/template/{_config.yml → _config.yml.tt} +2 -8
- data/template/_data/{fixtures.yml → .keep} +0 -0
- data/template/_layouts/default.html +8 -7
- data/template/{apple-touch-icon-precomposed.png → apple-touch-icon.png} +0 -0
- data/template/{bower.json → bower.json.tt} +1 -1
- data/template/favicon.ico +0 -0
- metadata +11 -11
- data/template/.scss-lint.yml +0 -22
- data/template/README.md +0 -43
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4ac58d83017de50db4f432b141d51bce5e3e3a48
|
4
|
+
data.tar.gz: ffedf17081bbbdb3cfbb519fc270f468e114a5ee
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a4e5e91bbedfafae7a36d450177329f2e0afcbbeb8c74c92d583f6bc6ab05cf7935e987cdcc1f18f32b906e742470f15ff4ab07414364ff86fc1a8905e5f4939
|
7
|
+
data.tar.gz: e088495db8749a01a5b227b832c63839333e4efd74ad71ee18a102de2bee73a308a86b3945f95fa219088c20a0762d074ddbc0d3c393b9a203320b3a51f6c545
|
data/.gitignore
CHANGED
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -1,4 +1,5 @@
|
|
1
|
-
|
1
|
+
Kickster
|
2
|
+
========
|
2
3
|
|
3
4
|
Jekyll starter template with GitHub Pages deploy to kickstart your project.
|
4
5
|
|
@@ -27,7 +28,7 @@ Run Jekyll
|
|
27
28
|
bundle exec jekyll serve --watch
|
28
29
|
|
29
30
|
Used tools:
|
30
|
-
- [Jekyll assets](
|
31
|
+
- [Jekyll assets](https://github.com/jekyll/jekyll-assets)
|
31
32
|
- [Bower](http://bower.io/)
|
32
33
|
- [Jekyll](http://jekyllrb.com/)
|
33
34
|
- Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
|
@@ -56,3 +57,5 @@ MIT License
|
|
56
57
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
57
58
|
4. Push to the branch (`git push origin my-new-feature`)
|
58
59
|
5. Create a new Pull Request
|
60
|
+
|
61
|
+
Big thanks to [@wouterw](https://github.com/wouterw) for helping out with his Ruby magic.
|
data/bin/kickster
CHANGED
data/kickster.gemspec
CHANGED
@@ -1,19 +1,22 @@
|
|
1
|
+
$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
|
2
|
+
require "kickster/version"
|
3
|
+
|
1
4
|
Gem::Specification.new do |spec|
|
2
5
|
spec.name = "kickster"
|
3
|
-
spec.version =
|
6
|
+
spec.version = Kickster::VERSION
|
4
7
|
spec.platform = Gem::Platform::RUBY
|
5
8
|
spec.author = "Nielsen Ramon"
|
6
9
|
spec.summary = "Hassle-free deploying to GitHub Pages with Jekyll."
|
7
10
|
spec.description = "Jekyll starter template with GitHub Pages deploy to kickstart your project."
|
8
11
|
spec.email = "nielsenramon1@gmail.com"
|
9
|
-
spec.homepage = "http://nielsenramon.com/
|
12
|
+
spec.homepage = "http://kickster.nielsenramon.com/"
|
10
13
|
spec.license = "MIT"
|
11
14
|
|
12
15
|
spec.files = `git ls-files`.split("\n")
|
13
|
-
spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
16
|
+
spec.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
|
14
17
|
spec.require_paths = ['lib']
|
15
18
|
|
16
|
-
spec.add_runtime_dependency("thor")
|
19
|
+
spec.add_runtime_dependency("thor", "~> 0")
|
17
20
|
spec.add_development_dependency "bundler", "~> 1.8"
|
18
21
|
spec.add_development_dependency "rake", "~> 10.0"
|
19
22
|
end
|
data/lib/kickster.rb
CHANGED
data/lib/kickster/generator.rb
CHANGED
@@ -1,57 +1,16 @@
|
|
1
|
-
require "fileutils"
|
2
|
-
require "kickster/version"
|
3
|
-
require "pathname"
|
4
1
|
require "thor"
|
5
2
|
|
6
3
|
module Kickster
|
7
4
|
class Generator < Thor
|
8
|
-
|
5
|
+
include Thor::Actions
|
9
6
|
|
10
|
-
|
11
|
-
method_options :path => :string, :force => :boolean
|
12
|
-
def new(name)
|
13
|
-
if kickster_files_already_exist?(name) && !options[:force]
|
14
|
-
puts "Folder already exist, use --force to overwrite."
|
15
|
-
else
|
16
|
-
install_files(name)
|
17
|
-
puts "Kickster template folder successfully created!"
|
18
|
-
end
|
19
|
-
end
|
7
|
+
map ["-v", "--version"] => :version
|
20
8
|
|
21
|
-
desc
|
9
|
+
desc "version", "Show Kickster version"
|
22
10
|
def version
|
23
|
-
say "
|
24
|
-
end
|
25
|
-
|
26
|
-
private
|
27
|
-
|
28
|
-
def kickster_files_already_exist?(name)
|
29
|
-
install_path(name).exist?
|
11
|
+
say "Kickster #{Kickster::VERSION}"
|
30
12
|
end
|
31
13
|
|
32
|
-
|
33
|
-
@install_path ||= if options[:path]
|
34
|
-
Pathname.new(File.join(options[:path], name))
|
35
|
-
else
|
36
|
-
Pathname.new(name)
|
37
|
-
end
|
38
|
-
end
|
39
|
-
|
40
|
-
def install_files(name)
|
41
|
-
FileUtils.mkdir_p(install_path(name))
|
42
|
-
FileUtils.cp_r(template_files, install_path(name))
|
43
|
-
end
|
44
|
-
|
45
|
-
def template_files
|
46
|
-
Dir["#{template_directory}/."]
|
47
|
-
end
|
48
|
-
|
49
|
-
def template_directory
|
50
|
-
File.join(top_level_directory, "template")
|
51
|
-
end
|
52
|
-
|
53
|
-
def top_level_directory
|
54
|
-
File.dirname(File.dirname(File.dirname(__FILE__)))
|
55
|
-
end
|
14
|
+
register(Kickster::Install, "new", "new", "Create new folder with the Kickster template")
|
56
15
|
end
|
57
16
|
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
require "thor"
|
2
|
+
|
3
|
+
module Kickster
|
4
|
+
class Install < Thor::Group
|
5
|
+
include Thor::Actions
|
6
|
+
|
7
|
+
argument :name
|
8
|
+
class_options force: :boolean
|
9
|
+
|
10
|
+
def self.source_root
|
11
|
+
File.expand_path("../../../template", __FILE__)
|
12
|
+
end
|
13
|
+
|
14
|
+
def name_components
|
15
|
+
@_name_components ||= name.scan(/[[:alnum:]]+/)
|
16
|
+
end
|
17
|
+
|
18
|
+
def snake_name
|
19
|
+
@_snake_name = name_components.map(&:downcase).join("_")
|
20
|
+
end
|
21
|
+
|
22
|
+
def camel_name
|
23
|
+
@_camel_name = name_components.map(&:capitalize).join("")
|
24
|
+
end
|
25
|
+
|
26
|
+
def check_if_exists?
|
27
|
+
if File.directory?(snake_name) && !options[:force]
|
28
|
+
say "Folder already exist, use --force to overwrite.", :red
|
29
|
+
exit 1
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
def copy_templates
|
34
|
+
directory("./", "./#{snake_name}")
|
35
|
+
end
|
36
|
+
|
37
|
+
def report_success
|
38
|
+
say "Kickster template folder successfully created!", :green
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
data/lib/kickster/version.rb
CHANGED
data/template/.ruby-version
CHANGED
@@ -1 +1 @@
|
|
1
|
-
2.2.
|
1
|
+
2.2.3
|
data/template/Gemfile
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
source "https://rubygems.org"
|
2
2
|
|
3
|
-
gem "autoprefixer-rails"
|
4
|
-
gem "jekyll"
|
5
|
-
gem "jekyll-assets"
|
6
|
-
gem "jekyll-sitemap"
|
7
|
-
gem "sass"
|
8
|
-
gem "uglifier"
|
3
|
+
gem "autoprefixer-rails", "~> 6.1", ">= 6.1.0.1"
|
4
|
+
gem "jekyll", "~> 3.0", ">= 3.0.1"
|
5
|
+
gem "jekyll-assets", "~> 2.0"
|
6
|
+
gem "jekyll-sitemap", "~> 0.9.0"
|
7
|
+
gem "sass", "~> 3.4", ">= 3.4.19"
|
8
|
+
gem "uglifier", "~> 2.7", ">= 2.7.2"
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# <%= camel_name %>
|
2
|
+
|
3
|
+
### Installation
|
4
|
+
|
5
|
+
Set up your environment
|
6
|
+
|
7
|
+
bin/setup
|
8
|
+
|
9
|
+
### Development
|
10
|
+
|
11
|
+
Run Jekyll
|
12
|
+
|
13
|
+
bundle exec jekyll serve --watch
|
14
|
+
|
15
|
+
Used tools:
|
16
|
+
- [Jekyll assets](http://ixti.net/jekyll-assets/)
|
17
|
+
- [Bower](http://bower.io/)
|
18
|
+
- [Jekyll](http://jekyllrb.com/)
|
19
|
+
- Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
|
20
|
+
- [Autoprefixer](https://github.com/postcss/autoprefixer)
|
21
|
+
|
22
|
+
### Deploy to GitHub Pages
|
23
|
+
|
24
|
+
Run this script and add a customized deploy message:
|
25
|
+
|
26
|
+
bin/deploy "custom_message"
|
File without changes
|
@@ -1,4 +1,5 @@
|
|
1
1
|
permalink: pretty
|
2
|
+
name: <%= snake_name %>
|
2
3
|
|
3
4
|
exclude:
|
4
5
|
- .bowerrc
|
@@ -10,9 +11,6 @@ exclude:
|
|
10
11
|
- bin/*
|
11
12
|
|
12
13
|
assets:
|
13
|
-
dirname: assets
|
14
|
-
baseurl: /assets/
|
15
|
-
|
16
14
|
sources:
|
17
15
|
- _assets/fonts
|
18
16
|
- _assets/images
|
@@ -20,12 +18,8 @@ assets:
|
|
20
18
|
- _assets/stylesheets
|
21
19
|
- _vendor/
|
22
20
|
|
23
|
-
js_compressor: uglifier
|
24
|
-
css_compressor: sass
|
25
|
-
gzip: false
|
26
|
-
debug: true
|
27
|
-
|
28
21
|
baseurl: /
|
22
|
+
url: /
|
29
23
|
|
30
24
|
gems:
|
31
25
|
- jekyll-assets
|
File without changes
|
@@ -4,23 +4,24 @@
|
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
6
6
|
|
7
|
-
<title>{{ page.title }}</title>
|
7
|
+
<title>{{ site.name }} | {{ page.title }}</title>
|
8
8
|
|
9
9
|
<meta name="description" content="{{ page.description }}">
|
10
10
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
11
|
-
<meta name="author" content="">
|
12
11
|
|
13
12
|
<meta property="og:title" content="{{ page.title }}">
|
14
|
-
<meta property="og:url" content="{{ site.
|
13
|
+
<meta property="og:url" content="{{ site.url }}">
|
15
14
|
<meta property="og:description" content="{{ page.description }}">
|
16
|
-
<meta property="og:site_name" content="">
|
17
|
-
<meta property="og:image" content="
|
15
|
+
<meta property="og:site_name" content="{{ site.name }}">
|
16
|
+
<meta property="og:image" content="">
|
18
17
|
|
19
18
|
<meta name="twitter:card" content="summary">
|
20
|
-
<meta name="twitter:url" content="{{ site.
|
19
|
+
<meta name="twitter:url" content="{{ site.url }}">
|
21
20
|
<meta name="twitter:title" content="{{ page.title }}">
|
22
21
|
<meta name="twitter:description" content="{{ page.description }}">
|
23
|
-
<meta name="twitter:image" content="
|
22
|
+
<meta name="twitter:image" content="">
|
23
|
+
|
24
|
+
<link rel="apple-touch-icon" href="apple-touch-icon.png">
|
24
25
|
|
25
26
|
{% stylesheet application %}
|
26
27
|
</head>
|
Binary file
|
data/template/favicon.ico
CHANGED
Binary file
|
metadata
CHANGED
@@ -1,27 +1,27 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: kickster
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Nielsen Ramon
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2015-
|
11
|
+
date: 2015-11-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: thor
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- - "
|
17
|
+
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
19
|
version: '0'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
|
-
- - "
|
24
|
+
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '0'
|
27
27
|
- !ruby/object:Gem::Dependency
|
@@ -69,31 +69,31 @@ files:
|
|
69
69
|
- kickster.gemspec
|
70
70
|
- lib/kickster.rb
|
71
71
|
- lib/kickster/generator.rb
|
72
|
+
- lib/kickster/install.rb
|
72
73
|
- lib/kickster/version.rb
|
73
74
|
- template/.bowerrc
|
74
75
|
- template/.gitignore
|
75
76
|
- template/.ruby-version
|
76
|
-
- template/.scss-lint.yml
|
77
77
|
- template/404.html
|
78
78
|
- template/Gemfile
|
79
|
-
- template/README.md
|
79
|
+
- template/README.md.tt
|
80
80
|
- template/_assets/fonts/.keep
|
81
81
|
- template/_assets/images/.keep
|
82
82
|
- template/_assets/javascripts/application.js
|
83
83
|
- template/_assets/javascripts/vendor.js
|
84
84
|
- template/_assets/stylesheets/application.scss
|
85
|
-
- template/_config.yml
|
86
|
-
- template/_data
|
85
|
+
- template/_config.yml.tt
|
86
|
+
- template/_data/.keep
|
87
87
|
- template/_includes/.keep
|
88
88
|
- template/_layouts/default.html
|
89
|
-
- template/apple-touch-icon
|
89
|
+
- template/apple-touch-icon.png
|
90
90
|
- template/bin/deploy
|
91
91
|
- template/bin/setup
|
92
|
-
- template/bower.json
|
92
|
+
- template/bower.json.tt
|
93
93
|
- template/favicon.ico
|
94
94
|
- template/index.html
|
95
95
|
- template/robots.txt
|
96
|
-
homepage: http://nielsenramon.com/
|
96
|
+
homepage: http://kickster.nielsenramon.com/
|
97
97
|
licenses:
|
98
98
|
- MIT
|
99
99
|
metadata: {}
|
data/template/.scss-lint.yml
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
exclude:
|
2
|
-
- ''
|
3
|
-
|
4
|
-
linters:
|
5
|
-
StringQuotes:
|
6
|
-
enabled: true
|
7
|
-
style: double_quotes
|
8
|
-
|
9
|
-
UrlFormat:
|
10
|
-
enabled: false
|
11
|
-
|
12
|
-
SelectorDepth:
|
13
|
-
enabled: true
|
14
|
-
max_depth: 4
|
15
|
-
|
16
|
-
PropertySortOrder:
|
17
|
-
enabled: true
|
18
|
-
order: recess
|
19
|
-
|
20
|
-
NestingDepth:
|
21
|
-
enabled: true
|
22
|
-
max_depth: 4
|
data/template/README.md
DELETED
@@ -1,43 +0,0 @@
|
|
1
|
-
kickster
|
2
|
-
========
|
3
|
-
|
4
|
-
Jekyll starter template with GitHub Pages deploy to kickstart your project.
|
5
|
-
|
6
|
-
### Installation
|
7
|
-
|
8
|
-
Set up your environment
|
9
|
-
|
10
|
-
bin/setup
|
11
|
-
|
12
|
-
Update `baseurl` and `assets:baseurl` in `_config.yml` with the correct path.
|
13
|
-
|
14
|
-
*If you do not want the Kickster files but just the deploy then copy `bin/setup` script to your repo and your ready to go.*
|
15
|
-
|
16
|
-
### Development
|
17
|
-
|
18
|
-
Run Jekyll
|
19
|
-
|
20
|
-
bundle exec jekyll serve --watch
|
21
|
-
|
22
|
-
Used tools:
|
23
|
-
- [Jekyll assets](http://ixti.net/jekyll-assets/)
|
24
|
-
- [Bower](http://bower.io/)
|
25
|
-
- [Jekyll](http://jekyllrb.com/)
|
26
|
-
- Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
|
27
|
-
- [Autoprefixer](https://github.com/postcss/autoprefixer)
|
28
|
-
|
29
|
-
### Deploy to GitHub Pages
|
30
|
-
|
31
|
-
Run this script and add a customized deploy message:
|
32
|
-
|
33
|
-
bin/deploy "custom_message"
|
34
|
-
|
35
|
-
### Why
|
36
|
-
|
37
|
-
Setting up GitHub Pages websites with Jekyll for projects or clients is cumbersome as you have to setup everything from scratch. Kickster helps you kickstart your project settling you with a basic starter template and easy deploy. Deploying is completed in 1 second so updating your website or prototype is a breeze.
|
38
|
-
|
39
|
-
You can find example project [here](https://github.com/nielsenramon/kickster/tree/website).
|
40
|
-
|
41
|
-
### License
|
42
|
-
|
43
|
-
MIT License
|