kalanda / my-jekyll-grunt-template

My project template for frontend developments using Jekyll and Grunt

my-jekyll-grunt-template

This is a projects template for frontend developments using Jekyll and Grunt. Two options are available to install. You can install using Vagrant or install it locally. Go forward in this document to see how.

After the installation of either of the two options, you can run grunt serve for development mode and visit your app at http://localhost:9000. This will watch your files for changes and automatically rebuild and reload in the browser.

Also you can run grunt build to build a minified and optimized version into the /dist/ directory.

1. Install using Vagrant

1. Install Vagrant and VirtualBox
2. Then download the template project and unzip to some folder.
3. Open a terminal window and go to the new folder with cd /path/to/folder
4. Run vagrant up and take a coffee (or two). Don't care about red text and just wait the script to finish installing and provisioning the Vagrant box.
5. Run vagrant ssh to access the box
6. Run cd /vagrant
7. Now you can use grunt serve or grunt build

2. Install locally

---

Before start you have to install:

• RybyGems
• Node.js
• NPM

First, install Grunt and Bower globally:

$ npm install -g grunt-cli
$ npm install -g bower

Clone this repository:

$ git clone https://github.com/kalanda/my-jekyll-grunt-template.git

Change into the new directory:

$ cd my-jekyll-grunt-template

Install Bundler (see troubleshooting below if you are using OSX El Capitan):

$ sudo gem install bundler

Now run clean and install script:

$ ./clean.sh
$ ./install.sh

Troubleshooting

NOTE ONLY for users with OSX 10.11 El Capitan

OSX 10.11 has a new security feature named "System Integrity Protection" which protect integrity of some system paths. If you get a message like "Operation not permitted - /usr/bin/bundle" when installing Bundler in local you have to disable this security feature or maybe use the Vagrant option because is isolated from your system.

To disable "System Integrity Protection" on OSX 10.11:

1. Boot into the Recovery HD by restarting whilst holding ⌘R.
2. Open Terminal (from the Utilities menu).
3. Run the following command in Terminal: csrutil disable
4. Restart.

License

The MIT License (MIT)

Copyright (c) 2015 kalanda

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.