mirror of
https://github.com/terribleplan/next.js.git
synced 2024-01-19 02:48:18 +00:00
55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
|
[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-relay-modern)
|
||
|
|
||
|
# Relay Modern Server Express Example
|
||
|
|
||
|
## How to use
|
||
|
|
||
|
### Using `create-next-app`
|
||
|
|
||
|
Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
|
||
|
|
||
|
```bash
|
||
|
npx create-next-app --example with-relay-modern-server-express with-relay-modern-server-express-app
|
||
|
# or
|
||
|
yarn create next-app --example with-relay-modern-server-express with-relay-modern-server-express-app
|
||
|
```
|
||
|
|
||
|
### Download manually
|
||
|
|
||
|
Download the example [or clone the repo](https://github.com/zeit/next.js):
|
||
|
|
||
|
```bash
|
||
|
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-relay-modern-server-express
|
||
|
cd with-relay-modern-server-express
|
||
|
```
|
||
|
|
||
|
Install it:
|
||
|
|
||
|
```bash
|
||
|
npm install
|
||
|
# or
|
||
|
yarn
|
||
|
```
|
||
|
|
||
|
Run the project (it runs automatically the Relay ahead-of-time compilation)
|
||
|
|
||
|
```bash
|
||
|
npm run dev
|
||
|
# or
|
||
|
yarn dev
|
||
|
```
|
||
|
|
||
|
Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download)):
|
||
|
|
||
|
```bash
|
||
|
now
|
||
|
```
|
||
|
|
||
|
## The idea behind the example
|
||
|
|
||
|
[Relay Modern](https://facebook.github.io/relay/docs/relay-modern.html) 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.
|
||
|
|
||
|
In this simple example, we integrate Relay Modern seamlessly with Next by wrapping our _pages_ inside a [higher-order component (HOC)](https://facebook.github.io/react/docs/higher-order-components.html). Using the HOC pattern we're able to pass down a query result data created by Relay into our React component hierarchy defined inside each page of our Next application. The HOC takes `options` argument that allows to specify a `query` that will be executed on the server when a page is being loaded.
|
||
|
|
||
|
This example implements a simple graphql server using express, showing a custom graphql server integrated to next.js and relay modern.
|