next.js/examples/api-routes-apollo-server/README.md

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 Server 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. The integration with Next and Apollo Server is implemented using the apollo-server-integration-next community package.

Deploy your own

How to use

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

npx create-next-app --example api-routes-apollo-server api-routes-apollo-server-app

yarn create next-app --example api-routes-apollo-server api-routes-apollo-server-app

pnpm 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