Skip to main content

Create a fast static site in React using Gatsby

· 4 min read

Preview

The absence of middleman/database makes the static site much faster and reliable. They can be deployed using static servers like Netlify, Github, etc. So, they are much more secured and require very little maintenance. Gatsby is a React based open-source framework that can be used to create static sites.

History​

I have created my first website in 2011 using vanilla HTML and CSS. Then I wanted to have a blog on my site as well. Around 2014, I ported my site to Wintersmith. It was great for the time and it supports markdown for blog writing. But, I was using a pug template engine with coffee-script in the mix, which proves difficult to use and modify for me. Also, Wintersmith's was not in active development. I wanted to have full control of my template engine using javascript only. As I have a decent understanding of React, I was looking for a static site generator that is React based. Then I found Gatsby which was open-source and based on React. It also has a very active development community and a plethora of plugins.

Why static site?​

A good practice is don't go for a dynamic website unless need to. Some of the advantages are:

  1. Speed

    Since, we are just hosting and serving static files, when the user visits a page, all the web server has to do is to return a file. No server-side code is executed. With good caching policies and using CDNs, nothing can match the serving speed of a static site.

  2. Security

    As there’s no server-side processing (back-end/database) involved, the threat of code injection is minimal for a static website.

  3. Reliability

    It's very unlikely that something can go wrong in Serving just basic HTML files. However, in the case of a dynamic site, it may crash or goes down because of a server/database error.

  4. Hosting

    Usually, it's cheaper to host static websites. GitHub Pages, Firebase, Fast.io, Netlify, Amazon S3 are some of the popular choices.

  5. Scalability

    Handling massive traffic on a dynamic website might not be as easy, as it requires complex code running on the server. Host a static website on a Cloud provider with auto-scaling and we are good to go. You can also use a Content Delivery Network (CDN) to geographically cache your static files and the calls to your web server will be drastically reduced. Also, no database scaling will be required.

Using Gatsby​

To use gatsby you will first need node and npm. After that Gatsby can be installed using npm.

npm install -g gatsby-cli

The above command will install Gatsby CLI globally on your machine. It is used to perform common functionality, such as creating a Gatsby application based on a starter, spinning up a hot-reloading local development server, and more!

Now, you can use gatsby-cli to create a new react starter site for gatsby. There are plenty of starter/boilerplate projects available on the gatsby-starter section. We are using a simple blog boilerplate code.

gatsby new my-blog https://github.com/gatsbyjs/gatsby-starter-blog
cd my-blog

This will create a new project dir. The code structure is very similar to the react app.

.
├── content
│   ├── assets
│   └── blog
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── node_modules
│   └── ...
├── package.json
├── README.md
├── src
│   ├── components
│   ├── normalize.css
│   ├── pages
│   ├── style.css
│   └── templates
└── static
    ├── favicon.ico
    └── robots.txt

You can now start a development server. All the changes in the code will be reflected on the server in realtime.

gasby develop

You can visit http://localhost:8000/ to check your development server.

starter-blog

To deploy the site you first need to build the static pages using the build command.

gatsby build

This will generate the static site in the public directory. A local server can be used to test the generated site.

gatsby serve

Start blogging​

The home page can be changed by editing src/pages/index.js file. And you can add/remove blog posts from content/blog directory. Gatsby is not limited to just a blog type site. You can create almost any static-site imaginable with it. Visit gatsbyjs.com/showcase to see all the different types of sites that others have built.

This site is build using Gatsby.

Happy Coding!