Evandro

Macedo

's random thoughts

Evandro Macedo's random thoughts

How this blog was built

The decisions made and technologies used behind this blog

First, the repository of this blog is open-source, so you can explore the code for the things described here. Second, this stack is fully inspired in Willian Justen's stack. If you understand portuguese and want to learn all these technologies, he has an entire course about this.


The design

Before I talk about code, I'll briefly talk about the design. First of all, the general UI of this blog was inspired by newspapers layout:

Newspaper

The whole design was made using Sketch. I usually follow these steps when I'm building a layout:

  1. Do some research to find what I want.
  2. Create a wireframe for mobile and desktop.
  3. Create a Styleguide page and...
  4. Define the color pallet that will be used in light and dark (if exists) mode.
  5. Define the typography and its styles (like headline, subtitle, body, caption, etc.).
  6. Create an Assets page and put everything that will be used there, like backgrounds and icons.
  7. Create a layout for mobile with less than 480px, then will expanding 'till desktop layout.

Blog's layout

Generally I change some things when I start to code and see the results on the browser.


Gatsby

This site is powered by Gatsby which is an amazing framework for generating static sites. It uses React as front-end library, and GraphQL to consume content and assets. To better understand what Gatsby does:

  • First it pulls data from many data sources (CMSs, Markdown, APIs, etc.) with GraphQL.
  • With data in hands, we create components and templates with React.
  • When the work is done, Gatsby builds everything into static HTML, CSS and JS files.
  • With static files you can deploy your site easily on dozens of services. Gatsby now has its own Gatsby Cloud service.

Gatsby does a great work on performance, loading only the critical content and prefetching data for internal links. It is also very safe because everything is static, so you won't have any trouble with things like SQL Injection. And the main advantage of Gatsby is that you are working with cutting edge technologies and have an awesome developer experience. Other than that, it has an excellent documentation and a great community, so almost every problem you have probably has been solved by someone.

The framework uses a pluggable ecosystem and there is a plugin for everything you want. Below are some plugins I used:

Gatsby Image

gatsby-image provides a complete image optimization for your application, from image processing to advanced loading techniques. Among all the features, the ones that I like the most are the image resizing according to the device, lazy loading and the blur-up technique that shows a preview of the image while it loads.

Markdown and PrismJS

I use Markdown to write the posts of this blog. The gatsby-transformer-remark plugin parses all Markdown files and makes them available on GraphQL for you to use on your components.

To add syntax highlighting on posts' code blocks, I use PrismJS with the gatsby-remark-prismjs plugin.

PWA

The default Gatsby starter comes with two plugins that handles all PWA stuff for you:

With these 2 plugins you turn your site into a PWA with literally some lines of JSON configurations.

Google Analytics and Sitemap

gatsby-plugin-google-analytics inserts the Google Analytics script in your application. And the gatsby-plugin-sitemap creates a /sitemap.xml file when your site is running in production mode.

Styled Components

Styled Components is the most popular CSS-in-JS library out there. It uses tagged template literals to style your React components and generates unique class names so you don't have to worry about CSS conflicts. I use Kitze's way of importing Styled Components under the S. namespace:

styled-media-query

I aaalways forget the CSS syntax for media queries, so I use the styled-media-query's beautiful methods like lessThan(breakpoint). I also use generateMedia() to standardize the CSS breakpoints in one place and reuse elsewhere. I use the common large, medium and small breakpoints for general styles, but I also like to set specific breakpoints for some components. I believe that some components need more flexibility on breakpoints to deliver the better responsiveness as possible. So I define breakpoints like these ones:

import { generateMedia } from 'styled-media-query'

const mediaQuery = generateMedia({
  large: '1170px',
  medium: '768px',
  small: '480px',
  header: '848px',
  socialLinks: '960px',
  mastheadInfo: '416px',
  paginationText: '360px'
})

export default mediaQuery

And in the Styled Components I use them this way:

import styled from 'styled-components'
import mediaQuery from '../../styles/mediaQuery'

export const SocialLinksList = styled.ul`
  display: grid;
  grid-gap: 0.8rem;
  grid-auto-flow: column;
  grid-auto-columns: 3.2rem;
  align-items: center;
  list-style: none;

  ${mediaQuery.lessThan('socialLinks')`
    grid-auto-flow: row;
  `}
`

Algolia

The search functionality of this site is powered by Algolia. It's very fast and provides some features like query suggestions, typo tolerance, search by synonyms and custom rankings by attributes. It also has a powerful analytics tool that tells you the popular searches, geographical origin of the searches, no-results rate and more.

I know that some applications (like e-commerce) can take more advantage of Algolia compared to this blog, but it's for free to personal projects so it's a good fit for me.

Deploy - Netlify and NetlifyCMS

Probably the easiest thing I did when building this site. Netlify has a really impressive and smooth deployment experience. I just connected my GitHub repository, setted some environment variables, and in less than 30 seconds my application was live.

Netlify's continuous deployment lets you live preview how different branches will work, and the atomic deploy support allows you to rollback effortlessly. It's also really simple to set your domain and SSL. By clicking on one button you have HTTPS enabled on your site. Seriously, it's amazing.

I also use Netlify CMS to write my posts. It's integrated with my GitHub repository and provides a simple interface for creating and editing the posts. It has an intuitive editorial workflow that organizes your posts into drafts, in review and ready.


Thanks to all technologies I've used in this blog, specially Gatsby, I could get the best metrics and enabled PWA from the Lighthouse audit tool:

Lighthouse audit

I'm really amazed with the results and how I could learn a lot from the development of this site. And like Willian Justen always says:

There's nothing better than using your own blog as a test subject for learning.