How to deploy a Gatsby site to Netlify.
Divine Hycenth2 min read
Published on March 06, 2021.
Last edited: March 03, 2023 by: Divine Hycenth
- Basic knowledge of git
Netlify provides different ways to deploy a site. i.e
- Drag and drop
- Deploy from a git account.
For the purpose of this tutorial, we're going to be using the git option because it's the easiest way to set up Continuous Deployment. There're tons of git hosting service providers however, the three most popular ones are github, bitbucket and gitlab. I'm going to use github but you either option is fine.
Create a Github repository.#
Before you can create a repository you're going to need an account.
After that you can navigate to github.com/new to create a new repository:
After the repo is created, you'll see instructions on how to connect an existing app to the repo. We will use the steps in a minute, so you might keep this page open for reference.
Push your Gatsby app to github#
The next step is to push your files to your repository. However, if you don't have a project already setup you can easily bootstrap a new project using Gatsby's CLI.
Install Gatsby CLI:
npm install -g gatsby-cli
Then you can now scaffold a new gatsby project by running:
gatsby new gatsby-starter-defaultcd gatsby-starter-default
Since this article is not focused on gatsby I wont write much about it.
... we created a new gatsby project with the name
we change directory into it.
The next step is to add your remote repository, commit all your changes and push it to your remote repository on github. Copy and paste the following commands to your terminal. These commands were provided when you created a new github repository.
Deploy site to Netlify 🚀#
If you haven't yet, you'll need to sign up with Netlify. You can use Github, Gitlab, Bitbucket, or email to register.
Then, click the New Site From Git button. From here, you'll be given a choice for Cotinuous Deployment, so choose Github. This means that every time you check your code into your Github repository, your site will be rebuilt to reflect those changes.
Then select your repository.
Then next step is to configure your deployment. You can select any branch you wish if your repository contains multiple branches. The default branch is Master.
The next Field is the Build command field. Basically, Netlify allows you to run a command when it rebuilds your site. With Gatbsy sites, you almost always want to run
gatsby build. This does a production build of your site, and by default, puts the built assets in a directory called
public. This public directory is where Netlify will actually serve your site/files. For this reason, we will run the
gatsby buildcommand as well as tell Netlify our public directory is, in fact, called
After clicking Deploy Site, netlify will go ahead and pull your code from github, then run the command(s) we defined.
After a minute or so, you'll see that it's finished. Then you can go ahead and click on the link associated with your site
If you made it to this point, then I'm going say congratulations 🍻 because you did it.
I hope you find this helpful.