rsnext/examples/with-relay-modern
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
components Replace Graphcool with dedicated example GraphQL server using Prisma (#15752) 2020-08-05 06:26:54 +00:00
lib [Examples] Move with-relay-modern to SSG (#13882) 2020-06-08 15:41:47 +00:00
pages Run next/link codemod for Next.js 13 on examples (#41913) 2022-10-30 21:00:45 +01:00
queries Update Relay Modern example (#10150) 2020-01-20 16:31:45 -05:00
schema Upgrade to Prettier 2 (#13061) 2020-05-18 15:24:37 -04:00
.babelrc Include all files in Prettier (#17050) 2020-09-14 02:53:19 +00:00
.env Replace Graphcool with dedicated example GraphQL server using Prisma (#15752) 2020-08-05 06:26:54 +00:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
.graphqlconfig Replace Graphcool with dedicated example GraphQL server using Prisma (#15752) 2020-08-05 06:26:54 +00:00
package.json Update Examples to use React 18 (#42027) 2022-10-28 17:43:20 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00

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

Deploy the example using Vercel:

Deploy with Vercel

How to use

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

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

Download schema introspection data from configured Relay endpoint

npm run schema
# or
yarn schema

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

npm run relay
# or
yarn relay

Run the project

npm run dev
# or
yarn dev

Deploy it to the cloud with Vercel (Documentation).