gatsby README

The project's README from github.com/gatsbyjs/gatsby. As one markdown file: README.md.

Gatsby

Gatsby

The future of web development is here.

Gatsby is a free and open-source framework based on React that helps developers build blazing fast websites and apps.
It combines the control and scalability of dynamically rendered sites with the speed of static-site generation, creating a whole new web of possibilities.

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!

Quickstart · Tutorial · Plugins · Starters · Showcase · Contribute
Support: Discussions

Gatsby helps professional developers efficiently create maintainable, highly-performant, content-rich websites.

Learn how to use Gatsby for your next project.

🚀 Ship your first Gatsby site in 5 Minutes

Click the link below to quickly try the workflow of developing, building, and deploying websites with Gatsby and Netlify.

Deploy to Netlify

At the end of this process, you'll have

  1. a site working on Netlify
  2. a new repository that is linked to that new site
  3. as you push changes to your new repository, Netlify will automatically rebuild and redeploy your site!

💻 Get started with Gatsby locally 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. Initialize a new project.

    npm init gatsby
    

    Give it the name "My Gatsby Site".

  2. Start the site in develop mode.

    Next, move into your new site’s directory and start it up:

    cd my-gatsby-site/
    npm run develop
    
  3. Open the source code and start editing!

    Your site is now running at http://localhost:8000. Open the my-gatsby-site directory in your code editor of choice and edit src/pages/index.js. Save your changes, and the browser will update in real time!

At this point, you’ve 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.

We welcome suggestions for improving our docs. See the “how to contribute” documentation for more details.

Start Learning Gatsby: Follow the Tutorial · Read the Docs

🚢 Release Notes

Wondering what we've shipped recently? Check out our release notes for key highlights, performance improvements, new features, and notable bugfixes.

Also, read our documentation on version support to understand our plans for each version of Gatsby.

💼 Migration Guides

Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v5 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!

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.

📝 License

Licensed under the MIT License.

💜 Thanks

Thanks go out to all our many contributors creating plugins, starters, videos, and blog posts. And a special appreciation for our community members helping with issues and PRs, or answering questions on GitHub Discussions.

A big part of what makes Gatsby great is each and every one of you in the community. Your contributions enrich the Gatsby experience and make it better every day.

gatsby (gatsbyjs/gatsby)

ssg
Searching Database…

55.9K ·GitHub
What is this?Gatsby is a free, open-source framework based on React for building fast websites and web apps, mixing the control of dynamically rendered sites with the speed of static-site generation.
Is it strictly a static-site generator?Static generation is the default, but any page can switch to Deferred Static Generation or Server-Side Rendering instead. The result is a fully functional React app — blogs, e-commerce, dashboards.
What does getting a first site running locally look like?Initialize a new project, move into its directory and start the site in develop mode, then edit src/pages/index.js — the browser updates in real time. The README clocks this at about five minutes.
What do I need on my machine before creating a project?The repo pins Node.js 18 or newer (below 26) with npm 8+ or Yarn 1.17+. Nothing else — no database or external services — is required to start building.
Do I have to build everything with React and GraphQL?Yes — whatever the data source, sites are built with React and GraphQL, so that is the workflow you sign up for.
Where do the sites I build actually run?Gatsby is a Node-based tool you run on your own machine; what it outputs are normal websites and web apps that open in any browser.
Will I need my own server to keep the finished site online?No. Gatsby sites don't require a server — you can host the whole site on a CDN, and many run entirely free on Netlify and similar services.
Can I use Gatsby in commercial projects?Nothing stops you: the code is under the MIT License, so commercial use is fine.
Where can my content come from?Anywhere — Markdown files, headless CMSs like Contentful or WordPress, or a REST or GraphQL API. Source plugins load it all into one uniform GraphQL data layer to develop against.
What performance work does it do without me asking?Code splitting, image optimization, inlining critical styles, lazy-loading and prefetching are automated, so sites ace performance audits by default with no manual tuning.
How steep is the learning curve?Gentle by design: the in-depth official tutorial starts with zero assumptions about your level of ability and walks through every step, and the docs add how-to, reference and conceptual guides.
Creator
gatsbyjs
Size
1.1 GB
Stars
55.9K
Age
11y
Commits · 90 Days