kickster 1.1.4 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +14 -8
- data/circle.yml +2 -2
- data/lib/kickster/version.rb +1 -1
- data/snippets/circle/circle.yml +2 -2
- data/snippets/travis/.travis.yml +2 -2
- data/snippets/travis/README.md +4 -4
- data/template/.ruby-version +1 -1
- data/template/Gemfile +7 -7
- data/template/README.md.tt +8 -3
- data/template/_assets/images/og-image.jpg +0 -0
- data/template/_layouts/default.html +4 -8
- data/template/bin/setup +1 -0
- data/template/bower.json.tt +1 -1
- data/template/circle.yml +2 -2
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ba3b920c5bca4a60779ccccb3930be68f23cb621
|
|
4
|
+
data.tar.gz: 7948f35869baa0e045c33388f0cec3b461ca1f43
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f67d31f671c0341f3cf783f7cdca451c3b4fd0244bafe50462525015425a00f3e8766111739f88708f41468cbc1125e1125c3c70ad23f976e9f8bc9df24840b3
|
|
7
|
+
data.tar.gz: 46e9ed4b87b40c0c260ebc26a594bcd7e433f6f99be88dd1e63ea7f0fa66316ec8e36e8a0c35b1f590e82ff4f0fc4fc04bec8aed6dd9987925c1220e0b3df478
|
data/README.md
CHANGED
|
@@ -19,10 +19,6 @@ Setup your environment:
|
|
|
19
19
|
|
|
20
20
|
bin/setup
|
|
21
21
|
|
|
22
|
-
Don't forget to enable your repository on [Circle CI](https://circleci.com/docs/getting-started) and update the `_config.yml` file!
|
|
23
|
-
|
|
24
|
-
*If you do not want the Kickster files but just the deploy then copy the `bin/deploy` script to your repo and your ready to go.*
|
|
25
|
-
|
|
26
22
|
## Development
|
|
27
23
|
|
|
28
24
|
Run Jekyll:
|
|
@@ -33,17 +29,21 @@ Used tools:
|
|
|
33
29
|
- [Autoprefixer](https://github.com/postcss/autoprefixer)
|
|
34
30
|
- [Bower](http://bower.io/)
|
|
35
31
|
- [Circle CI](https://circleci.com/)
|
|
32
|
+
- [Html-proofer](https://github.com/gjtorikian/html-proofer)
|
|
36
33
|
- [Jekyll](http://jekyllrb.com/)
|
|
37
34
|
- [Jekyll assets](https://github.com/jekyll/jekyll-assets)
|
|
35
|
+
- [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap)
|
|
38
36
|
- [HTML5 Boilerplate](https://html5boilerplate.com/) (Influenced by)
|
|
39
37
|
|
|
40
|
-
|
|
38
|
+
*If you do not want the Kickster setup but just the deploy scripts then copy them from the `bin` folder.*
|
|
39
|
+
|
|
40
|
+
## Deploy to GitHub Pages
|
|
41
41
|
|
|
42
42
|
Run this in the root project folder in your console:
|
|
43
43
|
|
|
44
44
|
bin/deploy
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
*Don't forget to enable your repository on [Circle CI](https://circleci.com/docs/getting-started) and update the `_config.yml` file!*
|
|
47
47
|
|
|
48
48
|
## Automated deployment with Circle CI
|
|
49
49
|
|
|
@@ -53,7 +53,7 @@ Automated deployment is by default not included in your Kickster generated Jekyl
|
|
|
53
53
|
|
|
54
54
|
#### 1. Copy the required automated deploy script
|
|
55
55
|
|
|
56
|
-
Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/circle/automated) script inside the `/bin` folder of your project (
|
|
56
|
+
Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/circle/automated) script inside the `/bin` folder of your project (make sure the file has execute permissions!).
|
|
57
57
|
|
|
58
58
|
#### 2. Update `circle.yml`
|
|
59
59
|
|
|
@@ -64,7 +64,7 @@ Replace your `circle.yml` file with [this](https://github.com/nielsenramon/kicks
|
|
|
64
64
|
|
|
65
65
|
#### 3. Enable Circle CI.
|
|
66
66
|
|
|
67
|
-
Make sure you
|
|
67
|
+
Make sure you enabled your repository on Circle CI. In Circle CI go to `Project settings > Checkout SSH Keys` and create a new User key. This is required to push to the GitHub repo from a script (permissions).
|
|
68
68
|
|
|
69
69
|
<img src="https://dl.dropboxusercontent.com/u/20823269/kickster-circle.jpg" alt="Screenshot of user key creating in Circle CI">
|
|
70
70
|
|
|
@@ -72,6 +72,12 @@ That's it, start pushing changes and enjoy your automated deployments from now o
|
|
|
72
72
|
|
|
73
73
|
_Want to use Travis CI? [Click here](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) to view all info on how to setup._
|
|
74
74
|
|
|
75
|
+
## Support
|
|
76
|
+
|
|
77
|
+
Need help with setting up Kickster? Join me on [Gitter](https://gitter.im/nielsenramon/kickster) and I help you out.
|
|
78
|
+
|
|
79
|
+
If you found a bug please report it in [GitHub issues](https://github.com/nielsenramon/kickster/issues).
|
|
80
|
+
|
|
75
81
|
## License
|
|
76
82
|
|
|
77
83
|
MIT License
|
data/circle.yml
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
machine:
|
|
2
2
|
ruby:
|
|
3
|
-
version: 2.3.
|
|
3
|
+
version: 2.3.1
|
|
4
4
|
|
|
5
5
|
dependencies:
|
|
6
6
|
pre:
|
|
@@ -13,4 +13,4 @@ test:
|
|
|
13
13
|
- ls -al
|
|
14
14
|
- cd test && bin/setup
|
|
15
15
|
- cd test && bundle exec jekyll build
|
|
16
|
-
- cd test && bundle exec
|
|
16
|
+
- cd test && bundle exec htmlproofer ./_site --only-4xx --allow-hash-href
|
data/lib/kickster/version.rb
CHANGED
data/snippets/circle/circle.yml
CHANGED
|
@@ -3,7 +3,7 @@ machine:
|
|
|
3
3
|
USER_NAME: <your-github-username>
|
|
4
4
|
USER_EMAIL: <your-github-email>
|
|
5
5
|
ruby:
|
|
6
|
-
version: 2.
|
|
6
|
+
version: 2.3.1
|
|
7
7
|
|
|
8
8
|
dependencies:
|
|
9
9
|
pre:
|
|
@@ -12,7 +12,7 @@ dependencies:
|
|
|
12
12
|
test:
|
|
13
13
|
post:
|
|
14
14
|
- bundle exec jekyll build
|
|
15
|
-
- bundle exec
|
|
15
|
+
- bundle exec htmlproofer ./_site --only-4xx --allow-hash-href
|
|
16
16
|
|
|
17
17
|
deployment:
|
|
18
18
|
production:
|
data/snippets/travis/.travis.yml
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
language: ruby
|
|
2
2
|
rvm:
|
|
3
|
-
- 2.
|
|
3
|
+
- 2.3.1
|
|
4
4
|
install:
|
|
5
5
|
- ./bin/setup
|
|
6
6
|
script:
|
|
7
7
|
- bundle exec jekyll build --trace
|
|
8
|
-
- bundle exec
|
|
8
|
+
- bundle exec htmlproofer ./_site --only-4xx --allow-hash-href
|
|
9
9
|
after_success:
|
|
10
10
|
- test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && "./bin/automated"
|
|
11
11
|
env:
|
data/snippets/travis/README.md
CHANGED
|
@@ -11,11 +11,11 @@ Automated deployment is by default not included in your Kickster generated Jekyl
|
|
|
11
11
|
|
|
12
12
|
#### 1. Copy the required automated deploy script
|
|
13
13
|
|
|
14
|
-
Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/automated) script inside the `/bin` folder of your project (
|
|
14
|
+
Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/automated) script inside the `/bin` folder of your project (make sure the file has execute permissions!).
|
|
15
15
|
|
|
16
16
|
#### 2. Add `.travis.yml`
|
|
17
17
|
|
|
18
|
-
Copy the `.travis.yml` from the [snippets](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/.travis.yml) folder inside the `/bin` folder of your project(
|
|
18
|
+
Copy the `.travis.yml` from the [snippets](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/.travis.yml) folder inside the `/bin` folder of your project(make sure the file has execute permissions!).
|
|
19
19
|
|
|
20
20
|
And adjust the following 2 lines with your information:
|
|
21
21
|
|
|
@@ -33,14 +33,14 @@ First give it a proper name so it is easy to recognize later. Then check `repo`
|
|
|
33
33
|
|
|
34
34
|
Copy the generated token.
|
|
35
35
|
|
|
36
|
-
*Don't forget to enable your repository in [Travis CI](https://travis-ci.org/)
|
|
36
|
+
*Don't forget to enable your repository in [Travis CI](https://travis-ci.org/).*
|
|
37
37
|
|
|
38
38
|
Go back to your project in terminal and input the following:
|
|
39
39
|
|
|
40
40
|
gem install travis
|
|
41
41
|
travis encrypt GITHUB_TOKEN=secret-token-from-github --add
|
|
42
42
|
|
|
43
|
-
This added a line inside your `.travis.yml
|
|
43
|
+
This added a line inside your `.travis.yml` file like this:
|
|
44
44
|
|
|
45
45
|
secure: <encrypted token>
|
|
46
46
|
|
data/template/.ruby-version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
2.3.
|
|
1
|
+
2.3.1
|
data/template/Gemfile
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
source "https://rubygems.org"
|
|
2
2
|
|
|
3
|
-
gem "autoprefixer-rails"
|
|
4
|
-
gem "html-proofer"
|
|
5
|
-
gem "jekyll"
|
|
6
|
-
gem "jekyll-assets"
|
|
7
|
-
gem "jekyll-sitemap"
|
|
8
|
-
gem "sass"
|
|
9
|
-
gem "uglifier"
|
|
3
|
+
gem "autoprefixer-rails"
|
|
4
|
+
gem "html-proofer"
|
|
5
|
+
gem "jekyll"
|
|
6
|
+
gem "jekyll-assets"
|
|
7
|
+
gem "jekyll-sitemap"
|
|
8
|
+
gem "sass"
|
|
9
|
+
gem "uglifier"
|
data/template/README.md.tt
CHANGED
|
@@ -13,14 +13,19 @@ Run Jekyll:
|
|
|
13
13
|
bundle exec jekyll serve --watch
|
|
14
14
|
|
|
15
15
|
Used tools:
|
|
16
|
-
- [
|
|
16
|
+
- [Autoprefixer](https://github.com/postcss/autoprefixer)
|
|
17
17
|
- [Bower](http://bower.io/)
|
|
18
|
+
- [Circle CI](https://circleci.com/)
|
|
19
|
+
- [Html-proofer](https://github.com/gjtorikian/html-proofer)
|
|
18
20
|
- [Jekyll](http://jekyllrb.com/)
|
|
19
|
-
-
|
|
20
|
-
- [
|
|
21
|
+
- [Jekyll assets](https://github.com/jekyll/jekyll-assets)
|
|
22
|
+
- [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap)
|
|
23
|
+
- [HTML5 Boilerplate](https://html5boilerplate.com/) (Influenced by)
|
|
21
24
|
|
|
22
25
|
## Deploy to GitHub Pages
|
|
23
26
|
|
|
24
27
|
Run this in the root project folder in your console:
|
|
25
28
|
|
|
26
29
|
bin/deploy
|
|
30
|
+
|
|
31
|
+
[View this](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci) for more info about automated deployment with Circle CI.
|
|
Binary file
|
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
<meta property="og:url" content="{{ site.url }}">
|
|
12
12
|
<meta property="og:description" content="{{ page.description }}">
|
|
13
13
|
<meta property="og:site_name" content="{{ site.name }}">
|
|
14
|
-
<meta property="og:image" content="">
|
|
14
|
+
<meta property="og:image" content="{% asset_path og-image.jpg %}">
|
|
15
15
|
|
|
16
16
|
<meta name="twitter:card" content="summary">
|
|
17
17
|
<meta name="twitter:url" content="{{ site.url }}">
|
|
18
18
|
<meta name="twitter:title" content="{{ page.title }}">
|
|
19
19
|
<meta name="twitter:description" content="{{ page.description }}">
|
|
20
|
-
<meta name="twitter:image" content="">
|
|
20
|
+
<meta name="twitter:image" content="{% asset_path og-image.jpg %}">
|
|
21
21
|
|
|
22
22
|
<link rel="apple-touch-icon" href="{% asset_path apple-touch-icon.png %}">
|
|
23
23
|
|
|
@@ -38,12 +38,8 @@
|
|
|
38
38
|
{% javascript application %}
|
|
39
39
|
|
|
40
40
|
<script>
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
e=o.createElement(i);r=o.getElementsByTagName(i)[0];
|
|
44
|
-
e.src='https://www.google-analytics.com/analytics.js';
|
|
45
|
-
r.parentNode.insertBefore(e,r)}(window,document,'script','ga'));
|
|
46
|
-
ga('create','{{ site.ga_analytics }}','auto');ga('send','pageview');
|
|
41
|
+
window.ga=function(){ga.q.push(arguments)};ga.q=[];ga.l=+new Date;
|
|
42
|
+
ga('create','{{ site.ga_analytics }}','auto');ga('send','pageview')
|
|
47
43
|
</script>
|
|
48
44
|
</body>
|
|
49
45
|
</html>
|
data/template/bin/setup
CHANGED
data/template/bower.json.tt
CHANGED
data/template/circle.yml
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
machine:
|
|
2
2
|
ruby:
|
|
3
|
-
version: 2.3.
|
|
3
|
+
version: 2.3.1
|
|
4
4
|
|
|
5
5
|
dependencies:
|
|
6
6
|
pre:
|
|
@@ -9,4 +9,4 @@ dependencies:
|
|
|
9
9
|
test:
|
|
10
10
|
post:
|
|
11
11
|
- bundle exec jekyll build
|
|
12
|
-
- bundle exec
|
|
12
|
+
- bundle exec htmlproofer ./_site --only-4xx --allow-hash-href
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: kickster
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.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: 2016-
|
|
11
|
+
date: 2016-05-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: thor
|
|
@@ -85,6 +85,7 @@ files:
|
|
|
85
85
|
- template/README.md.tt
|
|
86
86
|
- template/_assets/fonts/.keep
|
|
87
87
|
- template/_assets/images/apple-touch-icon.png
|
|
88
|
+
- template/_assets/images/og-image.jpg
|
|
88
89
|
- template/_assets/javascripts/application.js
|
|
89
90
|
- template/_assets/javascripts/vendor.js
|
|
90
91
|
- template/_assets/stylesheets/application.scss
|