Skip to content

karpolan/nextjs-with-pages-mui-starter-ts

Repository files navigation

Starter project for Next.js with Pages Router + Material UI using TypeScript

Mix of Create Next App and MUI with set of reusable components and utilities to build professional NextJS application faster.

Warning: It looks like App Router is a winner over Pages Router so this template could be deprecated in the future... If you need a starter for App Router, check this repo

How to use

  1. Clone or download the repo from: https://github.com/karpolan/nextjs-with-pages-mui-starter-ts
  2. Copy .env.sample file into .env file
  3. Replace _TITLE_ and _DESCRIPTION_ in all files with own texts
  4. Check and resolve all // TODO: directives
  5. Add your own code :)

Available Scripts

In the project directory, you can run:

npm run dev or yarn dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run lint or yarn lint

Checks the code for errors and missing things

npm run format or yarn format

Formats the code according to ./prettierrc.js config

npm test or yarn test

Launches the test runner in the interactive watch mode.

npm run build or yarn build

Builds the app for production or local development to the .next folder.

yarn build:static or npm run build:static

Note: this is deprecated way to build the Next.js app!

Builds the SSG (static site generator) version of the app in the out folder.

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.