Relay is a JavaScript framework for building data-driven React applications.
JavaScript Other
Latest commit 379c936 Jan 21, 2017 @wincent wincent committed with facebook-github-bot Fix whitespace
Summary: Eliminate trailing whitespace and get rid of hard line-wrapping for consistency with the other Markdown documents.

Reviewed By: JenniferWang

Differential Revision: D4446523

fbshipit-source-id: a646a3b4a6e76f0ef39738b8e4dcca2994d61b17

README.md

Relay Build Status npm version

Relay is a JavaScript framework for building data-driven React applications.

  • Declarative: Never again communicate with your data store using an imperative API. Simply declare your data requirements using GraphQL and let Relay figure out how and when to fetch your data.
  • Colocation: Queries live next to the views that rely on them, so you can easily reason about your app. Relay aggregates queries into efficient network requests to fetch only what you need.
  • Mutations: Relay lets you mutate data on the client and server using GraphQL mutations, and offers automatic data consistency, optimistic updates, and error handling.

See how to use Relay in your own project or check out the community-driven tutorial at Learn Relay.

Example

The relay-examples repository contains an implementation of TodoMVC. To try it out:

git clone https://github.com/relayjs/relay-examples.git
cd relay-examples/todo && npm install
npm start

Then, just point your browser at http://localhost:3000.

Contribute

We actively welcome pull requests, learn how to contribute.

Users

We have a community-maintained list of people and projects using Relay in production.

License

Relay is BSD licensed. We also provide an additional patent grant.