Generally, I start a website project with an existing template that I then adapt and modify to suit the project’s needs. This weekend, I decided to start a new project from scratch so that I could sharpen both my Bootstrap and DevOps skills.
Rather than begin with a blank screen, I took advantage of several ‘state-of-the-craft’ frameworks and tools to help me along more quickly:
- HTML5 BoilerPlate, for overall project structure
- Bootstrap, for front-end styles, themes, and behaviors, using LESS
- Grunt.js, as a task runner for Bootstrap’s site build processes
- Node.js, to install Bootstrap and Grunt.js
This tutorial describes how to launch a new website project based on HTML5BoilerPlate and Bootstrap 3 with LESS. It will also touch on installing and using Node.js and Grunt.js – if these are already installed on your system, you can skip steps two and three.
Table of Contents:
- Starting Assumptions
- Install Node.js
- Install the Grunt CLI
- Set Up the Project Folder
- Install Bootstrap
- Test the Bootstrap Build Process
- Add .htaccess to the Fonts Folder
- Include the CSS & JS Files
- Add Content & Test
1: Starting Assumptions
Before starting, be sure the following is true:
- You are comfortable workingHTML, CSS, and JS
- You are familiar with command-line basics *
- Your system uses an Apache server
* Command-line instructions are shown for Linux Ubuntu 16.04. You may need to make adjustments if you are using a different OS, or if you prefer to use an IDE or GUI-based text-editor (i.e SublimeText).
2: Install Node.js
First thing is to make sure
node.js is installed. Node.js includes a package manager that will be used to install both Grunt and Bootstrap, namely
At the command line, navigate to the head of the root directory, then enter the following commands: *
curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash - sudo apt-get install -y nodejs
This will install the current stable version of
* Note these commands will work for Ubuntu 14.04 and 16.04. If you are on a different base, check out the node.js website for the correct commands.
3: Install the Grunt CLI
First, make sure your version of
npm is up-to-date. At the command line, navigate to the head of the system’s root directory and run:
sudo npm update -g npm
Next, install Grunt’s command line interface globally. From the same location as above, enter the following command:
sudo npm install -g grunt-cli
This will put the
grunt command in the system path, allowing it to be run from any directory.
If you run into any trouble with this or just want to know more, check out Grunt’s ‘getting started’ guide.
4: Set Up the Project Folder
Rather than starting from zero, we’ll use HTML5 Boiler Plate as a starting point.
Go to H5BP’s GitHub page, and download and unzip the source file package. Open the extracted folder and navigate into the
dist subfolder. Copy the contents of this subfolder and paste them into the root folder for your project.
Your project folder should now look something like this:
Open and review the
.htaccess file. This file contains code designed to maximize your site’s performance. Depending on your project’s hosting setup, some or all of what this file contains may not be needed.
If you’re not comfortable making changes, or if you don’t have permission to edit the server files, leave the
.htaccess file as-is. It will make the server work just a bit harder, but not so much that you’ll notice under most circumstances.
5: Install Bootstrap
This is where the power of
node.js shows it face. Navigate to the project’s root directory and type:
npm install bootstrap@3
This will create a directory named
node_modules and then install Bootstrap in a subdirectory named
Now navigate into the
/bootstrap folder and type:
npm to open the
package.json file that was installed as part of Bootstrap, and automatically install and update any dependencies that are listed.
6. Test the Bootstrap Build Process
At this stage, the Bootstrap code has been installed. We should now be able to make sure the Bootstrap build processes are working properly.
This is where Grunt starts to show its power. Out of the box, Bootstrap makes the following grunt commands available:
… Regenerates the
… Watches the Less source files and automatically recompiles them to CSS whenever you save a change.
grunt test(Run tests)
grunt docs(Build & test the docs assets)
bundle exec jekyll serve.
grunt(Build absolutely everything and run tests)
Not all of these commands will work out-of-the-gate – some will require extra packages, etc., to be installed. However,
grunt dist and
grunt watch – the two most important commands – work just fine.
grunt dist command takes care of compiling, compressing, and updating the CSS and JS files. The
grunt watch command automatically triggers
grunt dist whenever it detects changes to the CSS and JS files.
To execute these commands, go to the command line and navigate to
../node_modules/bootstrap, and enter the following:
If all has gone well so far, grunt will run the basic build processes involved in compiling and minifying the project’s LESS, CSS, and JS files.
7: Add .htaccess to the Fonts Folder
Create a new file in your code editor, and add the following lines:
<FilesMatch "\.(ttf|otf|eot|woff|woff2|svg)$"> <IfModule mod_headers.c> Header set Access-Control-Allow-Origin "*" </IfModule> </FilesMatch>
Save the newly created file directly inside the
fonts folder naming it
.htaccess file stays within the
fonts folder, ensuring web fonts work will in all browsers across all hosting and CDN services the project uses.
8: Include the CSS & JS Files
Open the project’s
index.html file, and make the following change in the
<!-- REMOVE THIS <link rel="stylesheet" href="css/normalize.css"> <link rel="stylesheet" href="css/main.css"> --> <!-- REPLACE WITH THIS --> <link rel="stylesheet" href="node_modules/bootstrap/dist/css/bootstrap.css"> <link rel="stylesheet" href="node_modules/bootstrap/dist/css/bootstrap-theme.css">
This will instruct the index page to load the new Bootstrap CSS files instead of the defaults that come with H5BP.
Now go to the bottom of
index.html to just before the Google Analytics script block, and make the following changes:
<script src="js/plugins.js"></script> <!-- REMOVE THIS <script src="js/main.js"></script> --> <!-- ADD THIS --> <script src="node_modules/bootstrap/dist/js/bootstrap.min.js"></script>
Save the file, but don’t close it just yet. We’ll be adding more to this page in the next step.
9: Add Content & Test
While we’re far from done, the basic setup can now be tested to make sure everything was properly installed and included. In the body section of
index.html, add this simple markup:
index.html to the server and open the page in a browser. If all has gone well, you should now see a styled page with a top menu bar, like so:
Shrink the browser to the size of a smartphone. You should now see a button that exposes a drop-down version of the main menu when clicked, like so:
If something has gone wrong, you’ll likely see un-styled content. Go back and keep debugging until it works.
At this stage, you should now have a robust, fully-configured – albeit ‘vanilla’ – Bootstrap project ready for development to begin.
Although everything should be working just fine with this setup, there are still many things that can be done to improve the project’s infrastructure before jumping right into development.
gruntfile.jsto save the compressed and minified CSS and JS files to the locations and filenames initially specified in the original H5BP template, allowing for more efficient script and file loading in production
- Modify the LESS infrastructure to extend (rather than modify) Bootstrap’s original files, allowing for easier upgrades and more efficient development
Avoid using Initializer to do the install – great idea, but the included versions of the various packages are out of date.