Relay is a JavaScript framework for building data-driven React applications.
JavaScript Other
Clone or download
Pull request Compare This branch is 1914 commits behind facebook:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
examples
scripts
src
website-prototyping-tools
website
.eslintignore
.eslintrc
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
PATENTS
README.md
USERS.md
gulpfile.js
package.json

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.

Learn how to use Relay in your own project.

Example

The repository comes with an implementation of TodoMVC. To try it out:

git clone https://github.com/facebook/relay.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.