Source Repository for GraphQL.org

This repository contains the source code for the GraphQL website.

You can find more discussions on the #website channel on the GraphQL Discord.

Table of Contents

• Overview
• Documentation
• Deployment
• How to Contribute
• CLA Process
• Financial Support

Overview

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. It provides:

• a complete and understandable description of the data in your API,
• support for powerful developer tooling, and
• precise querying, which offers several benefits:
  • clients request only the data they need, improving efficiency;
  • new fields and features can be added without impacting existing clients; and
  • field-level usage can be tracked and monitored for insights and optimization.

The GraphQL Specification is open source and governed by the GraphQL Foundation.

Documentation

• GraphQL Website
• Reference Documentation
• Language Support, Tools, and Services
• Frequently Asked Questions (FAQ)
• Community Resources

Deployment

The website is deployed via Vercel on merges to the source branch. To preview changes locally, follow these steps:

1. Clone the repository:
   git clone https://github.com/graphql/graphql.github.io.git
cd graphql.github.io
2. Install dependencies:
   npm install
3. Run the site locally:
   npm run dev

How to Contribute

We welcome contributions! 🎉 Please refer to our contributing guide for detailed instructions on how to make changes to the GraphQL website.

CLA Process

Before contributing, all participants must sign the free GraphQL Specification Membership Agreement. You only need to do this once, and it can be signed by:

• Individual contributors
• Employers

To initiate the signature process, please open a PR against this repository. The EasyCLA bot will block the merge if the membership agreement has not been signed.

For more information on the CLA, check out the detailed instructions here. If you encounter any issues, please contact us at [email protected].

Join the Foundation!

If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please consider becoming a member of the GraphQL Foundation.