mirror of
https://github.com/terribleplan/next.js.git
synced 2024-01-19 02:48:18 +00:00
8fdb133903
I've just thought of a way to improve the initial props page by adding an example for a list/detail page structure. To do that, I've created a separate `/detail` page, and a mock API which calls data from the array we made on the previous PR. A ListDetail component is created as an example for displaying detail. Page structure is also cleaned up. Should I go ahead and add an example on how to style with styled-jsx + its TS declarations? I might decide to do it within this week anyway. |
||
|---|---|---|
| .. | ||
| components | ||
| interfaces | ||
| pages | ||
| utils | ||
| .babelrc | ||
| next.config.js | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
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 @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.