meta /relay
Relay is a JavaScript framework for building data-driven React applications.
★ 18,981⑂ 1,894👁 320⑃ 3,010● 2,397▤ 92
More from this author
+0
Daily
18,981
stars
1,894
forks
320
watchers
3,010
prs
2,397
issues
92
releases
README
Relay · 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. 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 yarn yarn grats yarn relay yarn dev Then, just point your browser at http://localhost:5173. 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 MIT licensed. Thanks We'd like to thank the contributors that helped make Relay in open source possible. The open source project relay-hooks allowed the community to experiment with Relay and React Hooks, and was a source of valuable feedback for us. The idea for the useSubscription hook originated in an issue on that repo. Thank you @morrys for driving this project and for playing such an important role in our open source community. Thank you for helping make this possible!
Top issues
#1881How do we do server-side rendering with Relay Modern?63 comments · 2017-06-12#3975LSP error in Relay GraphQL VSCode Extension40 comments · 2022-06-13#1913GraphQL error handling in Relay Modern38 comments · 2017-06-23#2471[Modern] Query only the local client extension types will cause compiling error35 comments · 2018-06-15#91Hydrate scalar fields on client30 comments · 2015-08-17#2237Subsequent queries can cause previous data to appear "missing" due to normalization29 comments · 2017-12-15#1983Spread fragment through Connection28 comments · 2017-07-20#1995[Modern] mutation underfetching/overfetching23 comments · 2017-07-25
Latest release
v21.0.1 v21.0.1 2026-05-27Version 21.0.0 had an issue where it failed to include our new TypeScript types in the published NPM bundle. Thanks to @PHILLIPS71 for the pull request identifying and resolving the issue. This point release resolves that issue and includes a number of other minor improvements which have landed since to v21.0.0 release. Bug fixes - Fix(build): ship TypeScript definition files in gulp dist build (5287) by Jordan Phillips (commit) Added - Feat(compiler): add --noWatchman CLI flag (5292) by Jordan Eldredge (commit) Improvements - Feat: Warn on deprecated enum values used as arguments (52