by gatsbyjs

gatsbyjs / gatsby

Build blazing fast, modern apps and websites with React

47.5K Stars 9.0K Forks Last release: about 3 years ago (v1.5.2) MIT License 17.0K Commits 14.3K Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:


Gatsby v2

鈿涳笍 馃搫 馃殌

Fast in every way that matters

Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps

Gatsby is released under the MIT license. Current CircleCI build status. Current npm package version. Downloads per month on npm. Total downloads on npm. PRs welcome! Follow @gatsbyjs

Quickstart Tutorial Plugins Starters Showcase Contribute Support: Twitter & Discord

Gatsby is a modern web framework for blazing fast websites.

  • Go Beyond Static Websites. Get all the benefits of static websites with none of the limitations. Gatsby sites are fully functional React apps so you can create high-quality, dynamic web apps, from blogs to e-commerce sites to user dashboards.

  • Use a Modern Stack for Every Site. No matter where the data comes from, Gatsby sites are built using React and GraphQL. Build a uniform workflow for you and your team, regardless of whether the data is coming from the same backend.

  • Load Data From Anywhere. Gatsby pulls in data from any data source, whether it鈥檚 Markdown files, a headless CMS like Contentful or WordPress, or a REST or GraphQL API. Use source plugins to load your data, then develop using Gatsby鈥檚 uniform GraphQL interface.

  • Performance Is Baked In. Ace your performance audits by default. Gatsby automates code splitting, image optimization, inlining critical styles, lazy-loading, prefetching resources, and more to ensure your site is fast 鈥 no manual tuning required.

  • Host at Scale for Pennies. Gatsby sites don鈥檛 require servers so you can host your entire site on a CDN for a fraction of the cost of a server-rendered site. Many Gatsby sites can be hosted entirely free on services like GitHub Pages and Netlify.

Learn how to use Gatsby for your next project.

What鈥檚 In This Document

馃殌 Get Up and Running in 5 Minutes

You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these four steps:

  1. Install the Gatsby CLI.
   npm install -g gatsby-cli

  1. Create a Gatsby site from a Gatsby starter.

Get your Gatsby blog set up in a single command:

   # create a new Gatsby site using the default starter
   gatsby new my-blazing-fast-site
  1. Start the site in

Next, move into your new site鈥檚 directory and start it up:

   cd my-blazing-fast-site/
   gatsby develop
  1. Open the source code and start editing!

Your site is now running at

. Open the
directory in your code editor of choice and edit
. Save your changes, and the browser will update in real time!

At this point, you鈥檝e got a fully functional Gatsby website. For additional information on how you can customize your Gatsby site, see our plugins and the official tutorial.

馃帗 Learning Gatsby

Full documentation for Gatsby lives on the website.

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples head to our documentation. In particular, check out the 鈥Guides鈥, 鈥API Reference鈥, and 鈥Advanced Tutorials鈥 sections in the sidebar.

We welcome suggestions for improving our docs. See the 鈥渉ow to contribute鈥 documentation for more details.

Start Learning Gatsby: Follow the TutorialRead the Docs

馃捈 Migration Guides

Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v2 to your site without starting from scratch!

鉂 Code of Conduct

Gatsby is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Gatsby community to abide by our Code of Conduct. Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 馃挭馃挏

馃 How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! :muscle::purple_heart:

Check out our Contributing Guide for ideas on contributing and setup steps for getting our repositories up and running on your local machine.

A note on how this repository is organized

This repository is a monorepo managed using Lerna. This means there are multiple packages managed in this codebase, even though we publish them to NPM as separate packages.

Contributing to Gatsby v1

We are currently only accepting bug fixes for Gatsby v1. No new features will be accepted.

:memo: License

Licensed under the MIT License.

馃挏 Thanks

Thanks to our many contributors and to Netlify for hosting GatsbyJs and our example sites.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.