next.js/examples/with-typescript/README.md

TypeScript Next.js example

This is a really simple project that show the usage of Next.js with TypeScript.

How to use it?

Using create-next-app

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 manually

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

The idea behind the example

Use the @zeit/next-typescript plugin to inject the Webpack config required to compile TypeScript to JavaScript. For information about using a TSConfig have a look at the plugin page.