Back to Next Js

Relay Modern Example

examples/with-relay-modern/README.md

16.2.51.7 KB
Original Source

Relay Modern Example

Relay Modern is a new version of Relay designed from the ground up to be easier to use, more extensible and, most of all, able to improve performance on mobile devices. Relay Modern accomplishes this with static queries and ahead-of-time code generation.

This example relies on Prisma + Nexus for its GraphQL backend.

Deploy your own

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

bash
npx create-next-app --example with-relay-modern with-relay-modern-app
bash
yarn create next-app --example with-relay-modern with-relay-modern-app
bash
pnpm create next-app --example with-relay-modern with-relay-modern-app

Download schema introspection data from configured Relay endpoint

bash
npm run schema
# or
yarn schema
# or
pnpm schema

Run Relay ahead-of-time compilation (should be re-run after any edits to components that query data with Relay)

bash
npm run relay
# or
yarn relay
# or
pnpm relay

Run the project

bash
npm run dev
# or
yarn dev
# or
pnpm dev

Deploy it to the cloud with Vercel (Documentation).