Skip to content

Home

Jump to bottom
Joseph Pereniguez edited this page Aug 17, 2023 · 9 revisions

Prismic + Gatsby + Netlify boilerplate

Start a new project with this boilerplate using Gatsby and Prismic then deploy it with Netlify!

📋 Table of content

  • How to setup Prismic
  • How to setup the repository
  • How to setup Netlify

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a typical Gatsby project.

.
├── node_modules
├── src
     ├── components # your components
     ├── images # local images
     ├── pages # your pages
     ├── schemas # your Prismic data schemas
     ├── shared # constants, styles, components
     ├── templates # the structures of your pages
├── .gitignore
├── .env.sample
├── .prettierignore
├── .prettierrc
├── gatsby-config.js
├── package.json
└── README.md

/node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

/src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

.gitignore: This file tells git which files it should not track / not maintain a version history for.

.prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

.prettierignore: This file tells prettier which files it should not format.

gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

README.md: A text file containing useful reference information about your project.

Clone this wiki locally