Guides & Tutorials
A Step-by-Step Guide: Brunch on Netlify
Today, we're going to look at how to host a website built with Brunch on Netlify, including setting up continuous deployment.
Let's start from scratch. If you already have a Brunch site set up, you can skip straight to the Connecting to Netlify section.
This guide assumes you have Node.js installed.
Open your terminal, and enter the following command:
$ npm install -g brunch
-g flag will install Brunch globally on your system, which you need to make sure Brunch has access to the proper dependencies.
Additionally, you'll want to install
bower at this step as well, otherwise you'll run into a whole host of problems further on down the line:
$ npm install -g bower
Brunch uses skeletons to start projects, automatically installing specific dependencies and creating a file structure for you. We'll be using Brunch with Chaplin for the purposes of this tutorial. In the terminal, enter the following:
$ brunch new https://github.com/paulmillr/brunch-with-chaplin.git /PATH/TO/brunchnetlify
Whatever you decide to name your project, you must be sure not to call it just plain
brunch (which is why we are calling this project
Now you can see a
brunchnetlify directory, with all of the various assets you need to develop your site in
Change into this new directory:
$ cd PATH/TO/brunchnetlify
If you decided to call your project
brunch, the next command will fail:
$ npm install brunch --save
The above command inserts
brunch into the dependencies of your
package.json file, which tells Netlify what tools it needs to build your site. If you named your project
brunch, npm will refuse to add
brunch as a dependency of itself.
Brunch allows you to preview your work by running its own testing server:
$ brunch watch --server
Brunch will compile your site and allow you to open it in a browser at http://localhost:3333.
Like what you see? Great. Let's move on!
Now it's time to push it to your repo of choice. Directions for GitHub follow here.
Creating your Git Repo
Create a new repository on GitHub. To avoid errors, do not initialize the new repository with README, license, or gitignore files. You can add these files after your project has been pushed to GitHub.
Open Terminal (for Mac users) or the command prompt (for Windows and Linux users).
For our purposes, let's call your new repo "brunch".
In the terminal, initialize the local directory as a Git repository.
$ git init
Add the files in your new local repository. This stages them for the first commit.
$ git add .
Commit the files that you've staged in your local repository.
$ git commit -m 'First commit'
At the top of your GitHub repository's Quick Setup page, click the clipboard icon to copy the remote repository URL.
In Terminal, add the URL for the remote repository where your local repository will be pushed.
git remote add origin Git_Repository_URL
Verify your URL
git remote -v
Now, it's time to push the changes in your local repository to GitHub.
git push -u origin master
Now that your assets are up and running on GitHub, let's connect them to Netlify.
Connecting to Netlify
Step 1: Add Your New Site
Creating a new site on Netlify is simple. Once you've logged in, you'll be taken to https://app.netlify.com/sites. If you're just starting out, there's only one option.
Step 2: Link to Your GitHub
Clicking "New Site" brings you to this screen:
When you push to GitHub, Netlify does all the work. No more manual deploying of updates or changes!
Since your assets are hosted on GitHub, we'll need to link Netlify to GitHub. Click "Link to GitHub".
Step 3: Authorize Netlify
It's time to allow Netlify and GitHub to talk to each other. Clicking the "Authorize Application" button will do just that. Like it says in the image below, Netlify doesn't store your GitHub access token on our servers. If you'd like to know more about the permissions Netlify requests and why we need them, you can visit our documentation on Git provider permissions.
Step 4: Choose Your Repo
Now that you've connected Netlify and GitHub, you can see a list of your Git repos. There's the "brunch" repo we just pushed to GitHub. Let's select it.
Step 5: Configure Your Settings
Here you can configure your options. For the purposes of this tutorial, there's nothing you need to change, so just click "Save".
Step 6: Build Your Site
Now it's time to sit back and relax. Go grab something cold to drink, scratch the dog behind the ears, or just get up and walk around (you've probably been in front of the computer for too long today, right?). Netlify will do the rest, and you can watch the progress.
Step 7: Done
Wait, you thought there was going to be more? Nope! Netlify has done it all for you, including giving your site a temporary name. Now you can add your custom domain, and your site will be live for your adoring public to view. Congratulations, and thanks for using netlify!