c3e5caf110
* docs(examples): improve DX while copy command to create new project * chore: apply code review Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com> Co-authored-by: JJ Kasper <jj@jjsweb.site>
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# Relay Modern Example
|
|
|
|
[Relay Modern](https://relay.dev/) 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](https://github.com/prisma-labs/nextjs-graphql-api-examples) for its GraphQL backend.
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
|
|
|
|
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-relay-modern&project-name=with-relay-modern&repository-name=with-relay-modern)
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) 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
|
|
```
|
|
|
|
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
|
|
```
|
|
|
|
Run the project
|
|
|
|
```bash
|
|
npm run dev
|
|
# or
|
|
yarn dev
|
|
```
|
|
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|