kickster 0.2.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ac58d83017de50db4f432b141d51bce5e3e3a48
-  data.tar.gz: ffedf17081bbbdb3cfbb519fc270f468e114a5ee
+  metadata.gz: 39d4a15e78cf0ff3150cc1ad58c24c6699ebc1b6
+  data.tar.gz: 531f82623452317f33585786e1e26398d0961440
 SHA512:
-  metadata.gz: a4e5e91bbedfafae7a36d450177329f2e0afcbbeb8c74c92d583f6bc6ab05cf7935e987cdcc1f18f32b906e742470f15ff4ab07414364ff86fc1a8905e5f4939
-  data.tar.gz: e088495db8749a01a5b227b832c63839333e4efd74ad71ee18a102de2bee73a308a86b3945f95fa219088c20a0762d074ddbc0d3c393b9a203320b3a51f6c545
+  metadata.gz: a89dba382f77fcd34a6a10e5bd92acb6c101fdef7c190a5df0114de803803e2fdeac68d06f508cd702a82561bb368815723ddd635306340e5bbfcff9e2d065fb
+  data.tar.gz: c3843aeb6605dac9a4b299d4ae4da6152261f91446cfb546392b3014117625d0042f8a0ee72260f78203315aeb7cd59750590d68dc4b18f53e2894804a8c1431

data/.gitignore

@@ -1,6 +1,9 @@
+/.asset-cache/
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/_site/
+/_vendor/
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -5,4 +5,4 @@ branches:
 language: ruby
 notifications:
   email: false
-rvm: 2.1.3
+rvm: 2.2.3

data/README.md

@@ -1,9 +1,11 @@
 Kickster
 ========
 
-Jekyll starter template with GitHub Pages deploy to kickstart your project.
+[![Join the chat at https://gitter.im/nielsenramon/kickster](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/nielsenramon/kickster?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-### Installation
+Jekyll starter template with GitHub Pages (automated) deploy to kickstart your project.
+
+## Installation
 
 Install the gem:
 
@@ -13,17 +15,15 @@ Execute gem and scaffold Kickster files:
 
     kickster new site_name
 
-Set up your environment:
+Setup your environment:
 
     bin/setup
 
-Update `baseurl` and `assets:baseurl` in `_config.yml` with the correct path.
-
-*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.*
+*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.*
 
-### Development
+## Development
 
-Run Jekyll
+Run Jekyll:
 
     bundle exec jekyll serve --watch
 
@@ -34,23 +34,67 @@ Used tools:
   - Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
   - [Autoprefixer](https://github.com/postcss/autoprefixer)
 
-### Deploy to GitHub Pages
+## Manual deploy to GitHub Pages
+
+Run this in the root project folder in your console:
+
+    bin/deploy
+
+Thats it, enjoy your nicely build project on GitHub pages!
+
+## Automated deployment with TravisCI
+
+Automated deployment is not by default included in your generated Kickster project. Please follow the steps below to include automated deployment.
+
+*Note that changes will only deploy when your code is merged into master.*
+
+#### 1. Copy the required automated deploy script
+
+Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/automated) script inside the `/bin` folder of your project.
+
+#### 2. Update `.travis.yml`
+
+Replace your `.travis.yml` file with [this](https://github.com/nielsenramon/kickster/blob/master/snippets/.travis.yml) one.
+And adjust the following 2 lines with your information:
+
+    - USERNAME: <your-github-username>
+    - EMAIL: <your-github-email>
+
+#### 3. Create a personal access token
+
+This is required to push to the GitHub repo from a script.
+
+In GitHub go to `settings > Personal access tokens` and create a new one.
+First give it a proper name so it is easy to recognize later. Then check `repo` (check `public_repo` if it is a public repository) and click on create.
+
+<img src="https://dl.dropboxusercontent.com/u/20823269/kickster-token.png" alt="Screenshot of token generation in GitHub">
+
+Copy the generated token.
+
+*Don't forget to enable your repository in [Travis CI](https://travis-ci.org/)*
+
+Go back to your project in terminal and input the following:
+
+    gem install travis
+    travis encrypt GITHUB_TOKEN=secret-token-from-github --add
+
+This added a line inside your `.travis.yml' file like this:
 
-Run this script and add a customized deploy message:
+    secure: <encrypted token>
 
-    bin/deploy "custom_message"
+That's it, enjoy your automated deployments from now on!
 
-### Why
+## Why
 
 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.
 
 You can find example project [here](https://github.com/nielsenramon/kickster/tree/website).
 
-### License
+## License
 
 MIT License
 
-### Contributing
+## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/kickster/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/kickster.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.author        = "Nielsen Ramon"
   spec.summary       = "Hassle-free deploying to GitHub Pages with Jekyll."
-  spec.description   = "Jekyll starter template with GitHub Pages deploy to kickstart your project."
+  spec.description   = "Jekyll starter template with GitHub Pages (automated) deploy to kickstart your project."
   spec.email         = "nielsenramon1@gmail.com"
   spec.homepage      = "http://kickster.nielsenramon.com/"
   spec.license       = "MIT"

data/lib/kickster/version.rb

@@ -1,3 +1,3 @@
 module Kickster
-  VERSION = "0.2.0"
+  VERSION = "1.0.2"
 end

data/snippets/automated

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+ORIGIN_URL=`git config --get remote.origin.url`
+ORIGIN_CREDENTIALS=${ORIGIN_URL/\/\/github.com/\/\/$GITHUB_TOKEN@github.com}
+COMMIT_MESSAGE=$(git log -1 --pretty=%B)
+
+echo "Started deploying to the gh-pages branch."
+
+echo "Creating clean gh-pages branch."
+if [ `git branch | grep gh-pages` ]
+then
+  git branch -D gh-pages
+fi
+git checkout -b gh-pages
+
+echo "Building site."
+bower install
+bundle exec jekyll build --destination temp || exit 1
+
+echo "Removing old files"
+find . -maxdepth 1 ! -name 'temp' ! -name '.git' ! -name '.gitignore' -exec rm -rf {} \;
+
+mv temp/* . || exit 1
+rm -R temp/ || exit 1
+
+echo "Pushing content"
+git config user.name "$USERNAME"
+git config user.email "$EMAIL"
+
+git add -fA || exit 1
+git commit --allow-empty -m "$COMMIT_MESSAGE" || exit 1
+
+git push -f -q "$ORIGIN_CREDENTIALS" gh-pages > /dev/null 2>&1
+
+echo "Deployed Successfully"
+
+echo "Checking out previous branch"
+git checkout -
+bower install
+
+exit 0

data/snippets/travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+- 2.2.3
+install:
+- ./bin/setup
+script:
+- bundle exec jekyll build --trace
+- bundle exec htmlproof ./_site --only-4xx
+after_success:
+- test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && "./bin/travis-deploy"
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  - USERNAME: <your-github-username>
+  - EMAIL: <your-github-email>

data/template/.gitignore

@@ -1,5 +1,6 @@
 !.keep
 *.DS_Store
 *.sass-cache
+/.asset-cache/*
 /_site/*
 /_vendor/*

data/template/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.2.3
+install:
+- ./bin/setup
+script:
+- bundle exec jekyll build --trace
+- bundle exec htmlproof ./_site --only-4xx
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/template/Gemfile

@@ -1,8 +1,9 @@
 source "https://rubygems.org"
 
-gem "autoprefixer-rails", "~> 6.1", ">= 6.1.0.1"
-gem "jekyll", "~> 3.0", ">= 3.0.1"
-gem "jekyll-assets", "~> 2.0"
+gem "autoprefixer-rails", "~> 6.1.0.1"
+gem "html-proofer", "~> 2.5.2"
+gem "jekyll", "~> 3.0.1"
+gem "jekyll-assets", "~> 2.0.2"
 gem "jekyll-sitemap", "~> 0.9.0"
-gem "sass", "~> 3.4", ">= 3.4.19"
-gem "uglifier", "~> 2.7", ">= 2.7.2"
+gem "sass", "~> 3.4.19"
+gem "uglifier", "~> 2.7.2"

data/template/README.md.tt

@@ -1,26 +1,26 @@
 # <%= camel_name %>
 
-### Installation
+## Installation
 
-Set up your environment
+Setup your environment:
 
     bin/setup
 
-### Development
+## Development
 
-Run Jekyll
+Run Jekyll:
 
     bundle exec jekyll serve --watch
 
 Used tools:
-  - [Jekyll assets](http://ixti.net/jekyll-assets/)
+  - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
   - [Bower](http://bower.io/)
   - [Jekyll](http://jekyllrb.com/)
   - Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
   - [Autoprefixer](https://github.com/postcss/autoprefixer)
 
-### Deploy to GitHub Pages
+## Deploy to GitHub Pages
 
-Run this script and add a customized deploy message:
+Run this in the root project folder in your console:
 
-    bin/deploy "custom_message"
+    bin/deploy

data/template/_config.yml.tt

@@ -1,15 +1,3 @@
-permalink: pretty
-name: <%= snake_name %>
-
-exclude:
-  - .bowerrc
-  - .scss-lint.yml
-  - Gemfile
-  - Gemfile.lock
-  - README.md
-  - bower.json
-  - bin/*
-
 assets:
   sources:
     - _assets/fonts
@@ -19,10 +7,22 @@ assets:
     - _vendor/
 
 baseurl: /
-url: /
+
+exclude:
+  - .bowerrc
+  - .travis.yml
+  - bin/*
+  - bower.json
+  - Gemfile
+  - Gemfile.lock
+  - README.md
+
+ga_analytics: UA-XXXXXXXX-X
 
 gems:
   - jekyll-assets
   - jekyll-sitemap
 
-ga_analytics: UA-XXXXXXXX-X
+name: <%= snake_name %>
+
+permalink: pretty

data/template/_layouts/default.html

@@ -3,9 +3,7 @@
 <head>
   <meta charset="utf-8">
   <meta http-equiv="x-ua-compatible" content="ie=edge">
-
   <title>{{ site.name }} | {{ page.title }}</title>
-
   <meta name="description" content="{{ page.description }}">
   <meta name="viewport" content="width=device-width, initial-scale=1">
 

data/template/bin/deploy

@@ -1,15 +1,13 @@
-#!/bin/sh
+#!/usr/bin/env sh
 
 # Run this script to deploy the app to Github Pages.
 
+# Exit if any subcommand fails
 set -e
 
-if [ -z "$1" ]
-  then
-    echo 'Usage: bin/deploy "{commit message}"'
-    exit 1
-fi
+echo "Started deploying"
 
+# Checkout gh-pages branch.
 if [ `git branch | grep gh-pages` ]
 then
   git branch -D gh-pages
@@ -17,23 +15,25 @@ fi
 
 git checkout -b gh-pages
 
+# Generate site.
 bower install
-bundle exec jekyll build --destination _site
+bundle exec jekyll build --destination temp
 
+# Port everyting needed inside temp folder.
 mkdir tmp
-cp -a _site/ tmp
-cp -a .gitignore tmp
-cp -R .git tmp
-
-find . -maxdepth 1 ! -name 'tmp' -exec rm -rf {} \;
+find . -maxdepth 1 ! -name 'temp' ! -name '.git' ! -name '.gitignore' -exec rm -rf {} \;
 
-cp -a tmp/. .
-rm -Rf tmp
+# Move site to root and cleanup files.
+mv temp/* .
+rm -R temp/
 
+# Push to gh-pages
 git add -fA
-git commit -m "$1"
-
-git push -f origin gh-pages
+git commit --allow-empty -m "$(git log -1 --pretty=%B)"
+git push -f -q origin gh-pages
 
+# Move back to previous branch
 git checkout -
 bower install
+
+echo "Deployed Successfully!"

data/template/bower.json.tt

@@ -1,6 +1,6 @@
 {
   "name": "<%= snake_name %>",
   "dependencies": {
-    "jquery": "~1.11.2"
+    "jquery": "~1.11.3"
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kickster
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Nielsen Ramon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Jekyll starter template with GitHub Pages deploy to kickstart your project.
+description: Jekyll starter template with GitHub Pages (automated) deploy to kickstart
+  your project.
 email: nielsenramon1@gmail.com
 executables:
 - kickster
@@ -71,10 +72,12 @@ files:
 - lib/kickster/generator.rb
 - lib/kickster/install.rb
 - lib/kickster/version.rb
+- snippets/automated
+- snippets/travis.yml
 - template/.bowerrc
 - template/.gitignore
 - template/.ruby-version
-- template/404.html
+- template/.travis.yml
 - template/Gemfile
 - template/README.md.tt
 - template/_assets/fonts/.keep

data/template/404.html

@@ -1,53 +0,0 @@
-<!DOCTYPE html>
-<html lang="">
-<head>
-  <meta charset="utf-8">
-  <title>Page Not Found</title>
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <style type="text/css">
-    * {
-      line-height: 1.2;
-      margin: 0;
-    }
-
-    html {
-      color: #888;
-      display: table;
-      font-family: sans-serif;
-      height: 100%;
-      text-align: center;
-      width: 100%;
-    }
-
-    body {
-      display: table-cell;
-      vertical-align: middle;
-      margin: 2em auto;
-    }
-
-    h1 {
-      color: #555;
-      font-size: 2em;
-      font-weight: 400;
-    }
-
-    p {
-      margin: 0 auto;
-      width: 280px;
-    }
-
-    @media only screen and (max-width: 280px) {
-      body, p { width: 95%; }
-
-      h1 {
-        font-size: 1.5em;
-        margin: 0 0 0.3em;
-      }
-    }
-  </style>
-</head>
-<body>
-  <h1>Page Not Found</h1>
-  <p>Sorry, but the page you were trying to view does not exist.</p>
-</body>
-</html>