A Fast SCSS Learning Feedback Loop With Harp and BrowserSync
May 2019
If, like me, your development career has been firmly on servers, wiring and protecting data across multiple machine and focusing on architecture, the shift to building websites that "look right" can sometimes be a tough transition. Like all things engineering, ensuring that you have a short feedback loop, where you can interact with the tool that you're using in a very hands on way, will be your fastest and surest way to mastery.
There are two very different parts to any web application: the style of the page and the business logic of the page. Both of these parts will more or less need to know about the structure of the page [though limiting that from a CSS perspective is quite important as well], but the style and the business logic can exist in harmony and separate out their concerns. Coming from the back end, business logic is no problem--unit test, code, unit test, code, refactor, more unit tests and code. Structure isn't even a problem, because HTML is very simple. When we start throwing in CSS is where traditional system level developers get thrown out of their comfort zone.
In learning SCSS, which is a great tool to prevent duplication in plain-text CSS files, I found a simple sandbox setup that will help any developer get up and running as quickly as possible, using harp and browsersync.
The Environment
First, ensure that you have harp and browser sync installed globally:
$ npm install -g browser-sync
$ npm install -g harp
Note that, depending on how you installed npm, you might have to prepend either or both of the above commands with sudo.
Then, set up a simple project directory like so:
index.html
run.sh
css/
-- _variables.scss
-- main.scss
To start with, you can set up your index.html file to look like:
<html>
<head>
<link href="css/main.css" type="text/css" rel="stylesheet">
</head>
<body>
<p> Some stuff </p>
<p>Some other stuff</p>
<p>Some other stuff</p>
</body>
</html>
Your _variables.scss file can look like:
$something: red;
Your main.scss file could look like:
@import "variables";
body {
font: 12px Helvetica, Arial, sans-serif;
color: $something;
}
Finally, your run.sh file could look like:
#!/bin/bash
harp server &
browser-sync start --proxy 'localhost:9000' --files '**, *.html, *.scss'
If you're on a *nix operating system, be sure to set the permissions to run this file:
$ sudo chmod 755 ./run.sh
You should then be able to run:
$ ./run.sh
[Browsersync] Proxying: http://localhost:9000
[Browsersync] Access URLs:
-------------------------------------
Local: http://localhost:3000
External: http://192.168.0.20:3000
-------------------------------------
UI: http://localhost:3001
UI External: http://localhost:3001
-------------------------------------
[Browsersync] Watching files...
------------
Harp v0.30.0 – Chloi Inc. 2012–2015
Your server is listening at http://localhost:9000/
Press Ctl+C to stop the server
By opening up http://localhost:3000, any changes you make to your source files will be automatically reloaded in your browser window, enabling you to immediately see the style changes.
Go forth and conquer.
Nick Fisher is a software engineer in the Pacific Northwest. He focuses on building highly scalable and maintainable backend systems.