Skip to content

Latest commit

 

History

History
102 lines (68 loc) · 3.68 KB

README.md

File metadata and controls

102 lines (68 loc) · 3.68 KB
Raw

Gatsby Starter Nova

A new gatsby starter using the latest dependencies and standards.

Please note, this is currently a work in progress so use at your own risk.

Basic Installation

  1. Install the Gatsby CLI tool if you don't have it: yarn global add gatsby-cli
  2. Clone the repo: git clone https://github.com/dvzrd/gatsby-starter-nova.git
  3. cd gatsby-starter-nova
  4. yarn
  5. yarn dev to start a local dev server at http://localhost:8000

Stack

  • GatsbyJS (Client)
  • GraphQL (Data)
  • MDX (Content)
  • Netlify (Server)
  • TailwindCSS (Styles)
  • TypeScript (Types)

Gatsby

Nova is composed of different gatsby plugins and themes.

For info about gatsby plugins and themes, see the following:

Gatsby Plugins

Gatsby MDX

MDX with gatsby-plugin-mdx.

  • Configure plugins and other options in gatsby-config.
  • Configure render options in components/mdx

Gatsby Next SEO

SEO with gatsby-plugin-next-seo.

  • Configure defaults in gatsby-config.
  • Configure page level SEO in pages by passing seo props to layouts.
  • Configure seo props in the frontmatter of your mdx/md files.

Custom Plugins and Themes

Coming soon:

  • Components with TailwindCSS
    • Compositional UI Components
    • Primitive UI Components
    • Structural UI Components
    • Typography UI Components
  • Forms
    • Form Container Compositions
    • React Hook Form
    • Mailchimp / Netlify Integration
  • MDX
    • Blog
    • Case Studies
    • Portfolio
    • Projects

Netlify

You can use netlify to host the build, for more info about Netlify, visit their site. If you prefer to host on your own service or another platform, feel free to remove any netlify related files.

Dev

It's recommended you setup netlify cli and run this project locally with netlify dev. For more info about netlify dev and how to set up, see the following resources:

Netlify Config

Netlify allows for file configs of their host server - allowing devs to push changes to our builds without needing to login to the netlify app dashboard.

Reference the Netlify docs on file based configuration for more detils.

Netlify Functions

You can also setup AWS serverless Lambda functions with Netlify, allowing you to send and receive data without needing your own server.

These are also called private functions because they're placed inside a private .netlify dir. To keep this dir private, it's automatically added to .gitignore, but feel free to change that if you want to version control your functions in a private repo or if you're using environment variables to hide your secret API keys.

Reference the Netlify docs on functions for more detials.

Roadmap