Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
Install the gem:
gem install kickster
Execute gem and scaffold Kickster files:
kickster new site_name
Setup your environment:
bin/setup
Don't forget to enable your repository on Circle CI!
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.
Run Jekyll:
bundle exec jekyll serve --watch
Used tools:
- Autoprefixer
- Bower
- Circle CI
- Jekyll
- Jekyll assets
- HTML5 Boilerplate (Influenced by)
Run this in the root project folder in your console:
bin/deploy
That's it, enjoy your nicely build project on GitHub pages!
Automated deployment is by default not included in your Kickster generated Jekyll project. Please follow the steps below to include automated deployment.
Note that changes will only deploy when your code is merged into master.
Copy the automated script inside the /bin folder of your project (check if the file has execute permissions!).
Replace your circle.yml file with this one. And adjust the following 2 lines with your information:
- USER_NAME: <your-github-username>
- USER_EMAIL: <your-github-email>
Make sure you enable your repository in 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).
That's it, start pushing changes and enjoy your automated deployments from now on!
Want to use Travis CI? Click here to view all info on how to setup.
MIT License
- Fork it ( https://github.com/[my-github-username]/kickster/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Big thanks to @wouterw for helping out with his Ruby magic.