Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.37 KB

README.md

File metadata and controls

37 lines (20 loc) · 1.37 KB
Raw

nom-nom

A Gatsby and Contentful powered recipe website for the funs.

Intro

(Borrowed from the Gatsby Contenful starter)

Static sites are scalable, secure and have very little required maintenance. They come with a drawback though. Not everybody feels good editing files, building a project and uploading it somewhere. This is where Contentful comes into play.

With Contentful and Gatsby you can connect your favorite static site generator with an API that provides an easy to use interface for people writing content and automate the publishing using services like Circle CI.

Requirements

To use this project you have to have a Contentful account. If you don't have one yet you can register at www.contentful.com/sign-up.

Getting started

  1. Clone
  2. Install (npm install or yarn install)
  3. Run (npm run start or yarn run start)

Crucial Commands

This project comes with a few handy commands for linting and code fixing. The most important ones are the ones to develop and ship code. You can find the most important commands below.

yarn run dev

Run in the project locally.

yarn run build

Run a production build into ./public. The result is ready to be put on any static hosting you prefer.

yarn run deploy

Run a production build into ./public and publish the site to GitHub pages.