GithubHelp home page GithubHelp logo

drmartin1998 / gatsby Goto Github PK

View Code? Open in Web Editor NEW

This project forked from gatsbyjs/gatsby

0.0 0.0 0.0 878.95 MB

Build blazing fast, modern apps and websites with React

Home Page:

License: MIT License

JavaScript 66.95% CSS 1.68% Dockerfile 0.04% TypeScript 30.24% HTML 0.87% Shell 0.16% Python 0.01% Handlebars 0.03% EJS 0.01% Less 0.01% SCSS 0.01% Stylus 0.01%

gatsby's Introduction


Gatsby v3

鈿涳笍 馃搫 馃殌

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

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 Gatsby Cloud and other similar services.

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
  2. 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 interactive setup wizard
    # Give it this name: My Gatsby site
    gatsby new
  3. Start the site in develop mode.

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

    cd my-gatsby-site/
    gatsby develop
  4. 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鈥檝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 鈥How-to Guides鈥, 鈥Reference鈥, and 鈥Conceptual Guides鈥 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

馃殺 Release Notes

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

馃捈 Migration Guides

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

Contributing to Gatsby v2

We are only accepting critical security patches for Gatsby v2.

馃摑 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 Discord and 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's People


amberleyromo avatar ascorbic avatar blainekasten avatar calcsam avatar christopherbiscardi avatar dschau avatar fk avatar freiksenet avatar gillkyle avatar jbampton avatar johno avatar jquense avatar kyleamathews avatar lannonbr avatar lekoarts avatar m-allanson avatar mgienow avatar mottox2 avatar muescha avatar mxstbr avatar pieh avatar pvdz avatar renovate[bot] avatar shannonbux avatar sidharthachatterjee avatar stefanprobst avatar tesseralis avatar valin4tor avatar vladar avatar wardpeet avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    馃枛 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 馃搳馃搱馃帀

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google 鉂わ笍 Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.