This is a really simple project that show the usage of Next.js with TypeScript.
Execute create-next-app
with Yarn or npx to bootstrap the example:
npx create-next-app --example with-typescript with-typescript-app
# or
yarn create next-app --example with-typescript with-typescript-app
Download the example:
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-typescript
cd with-typescript
Install it and run:
npm install
npm run dev
# or
yarn
yarn dev
Use the @zeit/next-typescript plugin to inject @babel/preset-typescript into Next.js, allowing for fast TypeScript transpilation. It also implements a tsconfig.json
as recommended by the @zeit/next-typescript plugin page.
A type-check
script is also added to package.json
, which runs TypeScript's tsc
CLI in noEmit
mode to run type-checking separately. You can then include this in your test
scripts, say, for your CI process.