Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.6 KB

README.md

File metadata and controls

65 lines (45 loc) · 2.6 KB
Raw

Starter template Gatsby simple blog with caisy

Gatsby x Caisy

Deploy this template to Vercel

Deploy to Vercel

Features

  • ✅ 100/100 Lighthouse performance
  • ✅ SEO-friendly with canonical URLs and OpenGraph data
  • ✅ Dynamic content updates from caisy without redeployment
  • ✅ Sitemap support

Requirements

In order to have the right blueprints configured, make sure to follow the onboard on caisy.io and select the starter template "Gatsby Simple Blog" To run this project a .env.production file like this (with your own projects values) is required:

CAISY_PROJECT_ID=a894c383-edfc-4499-a639-a40509986ed4
CAISY_API_KEY=xxx

To run this project locally

  • git clone https://github.com/caisy-io/starter-template-gatsby-simple-blog.git
  • create .env.development file with your project id and API key
  • yarn install
  • yarn develop

In order to have the right blueprints configured, make sure to follow the onboard and select the starter template "Gatsby Simple Blog"

We are using

  • Gatsby as server and server side rendering framework
  • tailwindcss for styling
  • @caisy/rich-text-react-renderer to render the caisy richtexts in Gatsby
  • gatsby-source-graphql plugin to fetch data from caisy

gatsby-plugin-graphql-codegen

During development we generate code using

  • gatsby-plugin-graphql-codegen & built-in by Gatsby graphqlTypegen

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
yarn install Installs dependencies
yarn develop Starts local dev server at localhost:8000
yarn build Build your production site to ./public/
yarn serve Run your production site on localhost:8000
gatsby ... Run CLI commands like gatsby clean,  gatsby check
gatsby --help Get help using the Gatsby CLI

👀 Want to learn more?

Feel free to check the Caisy documentation Feel free to check the Gatsby documentation