Maew (Mæw) Memorandum Steps to create this project Code: npx create-next-app getting-started --example with-typescript npm install -D tailwindcss postcss autoprefixer npx tailwindcss init -p
inside tailwind.config.js file content: [ './pages//*.{js,ts,jsx,tsx}', './components//*.{js,ts,jsx,tsx}', ],
create folder styles and file globals.css edit globals.css
create file _app.tsx
edit index.tsx
install Chakra yarn add @chakra-ui/react @emotion/react @emotion/styled framer-motion
edit _app.tsx & index.tsx
npm run dev
Create component modal
yarn add @fortawesome/fontawesome-svg-core
yarn add @fortawesome/free-solid-svg-icons yarn add @fortawesome/free-regular-svg-icons
yarn add @fortawesome/react-fontawesome@latest
yarn add react-router-dom installation NOT required for this project due to method change
yarn add react-hook-form installation NOT required for this project due to data validation method change
This is a really simple project that shows the usage of Next.js with TypeScript.
Deploy the example using Vercel or preview live with StackBlitz
Execute create-next-app
with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-typescript with-typescript-app
yarn create next-app --example with-typescript with-typescript-app
pnpm create next-app --example with-typescript with-typescript-app
Deploy it to the cloud with Vercel (Documentation).
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.