rsnext/examples/api-routes-apollo-server
Luc Leray f52955ec94
Clean up examples package.json (#27121)
Clean up package.json files in the `examples` directory:
- Add `private: true`
- Remove `version` (because they are irrelevant for packages that are not meant to be published)
- Remove `name` (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale)
- Remove `author`
- Remove `description`
- Remove `license`

Also remove `with-dynamic-app-layout` example completely, since it does the same as `layout-component` (https://github.com/vercel/next.js/pull/27121#discussion_r668178408).

## Documentation / Examples

- [x] Make sure the linting passes
2021-07-12 19:58:03 +00:00
..
pages Example: Static Generation of local Apollo GraphQL schema (#13202) 2020-05-27 06:05:10 +00:00
shared/query-graphql Example: Static Generation of local Apollo GraphQL schema (#13202) 2020-05-27 06:05:10 +00:00
.gitignore Added .gitignore to examples that are deployed to vercel (#15127) 2020-07-16 10:52:23 -04:00
package.json Clean up examples package.json (#27121) 2021-07-12 19:58:03 +00:00
README.md docs: add 'Open in StackBlitz' buttons to various examples (#25853) 2021-06-08 20:45:02 +00:00

Consume local Apollo GraphQL schema to create Static Generation export

Next.js ships with two forms of pre-rendering: Static Generation and Server-side Rendering. This example shows how to perform Static Generation using a local Apollo GraphQL schema within getStaticProps and getStaticPaths. The end result is a Next.js application that uses one Apollo GraphQL schema to generate static pages at build time and also serve a GraphQL API Route at runtime.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

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

npx create-next-app --example api-routes-apollo-server api-routes-apollo-server-app
# or
yarn create next-app --example api-routes-apollo-server api-routes-apollo-server-app

Deploy it to the cloud with Vercel (Documentation).

Notes

Static Export

If you wish to export a static HTML + JS version of the site you need to first change the setting in this example in ./pages/[username].js where getStaticPaths has fallback: true - this needs to be false for static export to work. You can then run npm run build and npm run export to export the site as a static folder in ./out directory.

Read more about fallback option