/gatsby-starter-skeleton

Gatsby starter featuring TypeScript, ESLint, Prettier and more...

Primary LanguageTypeScript

Node.js CI Status

Gatsby


Gatsby Skeleton is an (almost) barebones Gatsby v3 starter that intends to save the user the hassle of having to set up everything every time and start with development right away.

It includes TypeScript (even for the gatsby-* files!) along ESLint, Prettier, stylelint, simple-git-hooks and lint-staged.

For styling, styled-components is used. Everything already set up.

⚡ Features

dependencies:

├── gatsby-plugin-image
├── gatsby-plugin-react-helmet
├── gatsby-plugin-sharp
├── gatsby-plugin-sitemap
├── gatsby-plugin-styled-components
├── gatsby-plugin-svgr
├── gatsby-source-filesystem
├── gatsby-transformer-sharp
├── normalize.css
├── react-helmet
└── styled-components

devDependencies:

├── eslint
├── lint-staged
├── plop
├── prettier
├── simple-git-hooks
├── stylelint
└── typescript

🚀 Quick start

  1. Create a Gatsby site.

    Use the Gatsby CLI to create a new site, specifying the gatsby-skeleton starter.

    gatsby new my-project https://github.com/msallent/gatsby-starter-skeleton/
  2. Start developing.

    Navigate into your new site’s directory and start it up.

    cd my-project/
    yarn dev
  3. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the my-project directory in your code editor of choice and edit src/pages/index.tsx. Save your changes and the browser will update in real time!