Go to file
Kasper Juul Hermansen bd03bd5065
continuous-integration/drone/pr Build is passing Details
continuous-integration/drone/push Build is passing Details
Update dependency @mui/material to v5.15.18
2024-05-16 09:34:59 +00:00
.idea Add login page 2021-10-15 21:53:27 +02:00
components Add login page 2021-10-15 21:53:27 +02:00
features/auth Add login page 2021-10-15 21:53:27 +02:00
pages Add login page 2021-10-15 21:53:27 +02:00
.drone.yml Add .drone.yml 2022-10-26 16:16:44 +02:00
.gitignore Initial commit from Create Next App 2021-10-12 21:17:12 +02:00
README.md Initial commit from Create Next App 2021-10-12 21:17:12 +02:00
next-env.d.ts Initial commit from Create Next App 2021-10-12 21:17:12 +02:00
package.json Update dependency @mui/material to v5.15.18 2024-05-16 09:34:59 +00:00
renovate.json Add renovate.json 2022-10-25 20:56:33 +00:00
tsconfig.json Initial commit from Create Next App 2021-10-12 21:17:12 +02:00
yarn.lock Update dependency @mui/material to v5.15.18 2024-05-16 09:34:59 +00:00

README.md

TypeScript Next.js example

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

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use it?

Execute create-next-app with npm or Yarn 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

Deploy it to the cloud with Vercel (Documentation).

Notes

This example shows how to integrate the TypeScript type system into Next.js. Since TypeScript is supported out of the box with Next.js, all we have to do is to install TypeScript.

npm install --save-dev typescript

To enable TypeScript's features, we install the type declarations for React and Node.

npm install --save-dev @types/react @types/react-dom @types/node

When we run next dev the next time, Next.js will start looking for any .ts or .tsx files in our project and builds it. It even automatically creates a tsconfig.json file for our project with the recommended settings.

Next.js has built-in TypeScript declarations, so we'll get autocompletion for Next.js' modules straight away.

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, for example, in your test scripts.