f52955ec94
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 |
||
---|---|---|
.. | ||
lib | ||
pages | ||
test | ||
.babelrc | ||
.gitignore | ||
.graphql-let.yml | ||
jest.config.js | ||
next-env.d.ts | ||
next.config.js | ||
package.json | ||
README.md | ||
tsconfig.json |
TypeScript and GraphQL Example
One of the strengths of GraphQL is enforcing data types on runtime. Further, TypeScript and GraphQL Code Generator (graphql-codegen) make it safer by typing data statically, so you can write truly type-protected code with rich IDE assists.
This template extends Apollo Server and Client Example by rewriting in TypeScript and integrating graphql-let, which runs TypeScript React Apollo in graphql-codegen under the hood. It enhances the typed GraphQL use as below:
import { useNewsQuery } from './news.graphql'
const News = () => {
// Typed already️⚡️
const { data: { news } } = useNewsQuery()
return <div>{news.map(...)}</div>
}
By default **/*.graphqls
is recognized as GraphQL schema and **/*.graphql
as GraphQL documents. If you prefer the other extensions, make sure the settings of the webpack loader in next.config.js
and .graphql-let.yml
are consistent.
Preview
Preview the example live on StackBlitz:
Deploy your own
Deploy the example using Vercel:
How to use
Execute create-next-app
with npm or Yarn to bootstrap the example:
npx create-next-app --example with-typescript-graphql with-typescript-graphql-app
# or
yarn create next-app --example with-typescript-graphql with-typescript-graphql-app
Deploy it to the cloud with Vercel (Documentation).