nextjs/create-next-app

Create Next.js App

Scaffold a new Next.js project using the official CLI.

create
setup
scaffold
typescript
nextjs

Command

npx create-next-app@latest

Explanation

The `create-next-app` CLI tool simplifies Next.js setup by generating a pre-configured project with sensible defaults. It installs dependencies, sets up scripts, and creates essential files such as `pages/`, `app/`, and `next.config.js`. It supports TypeScript, ESLint, Tailwind CSS, and custom templates.

Common Use Cases

  • Quickly bootstrap a new Next.js project
  • Start a project with TypeScript or Tailwind preconfigured
  • Generate consistent folder structures for teams

Best Practices

  • Use `--typescript` flag for modern, type-safe Next.js projects
  • Initialize Git before creation to manage clean commits
  • Keep CLI updated using `npm install -g create-next-app`

Common Mistakes to Avoid

  • Forgetting to include the `@latest` tag and installing an outdated CLI version
  • Running the command in an existing directory with conflicting files

Troubleshooting

Problem: Permission denied when creating the app

Solution: Run the command with proper permissions or use a directory where you have write access.

Problem: Dependency installation failed

Solution: Use a different package manager (e.g., `--use-npm` or `--use-yarn`).

Examples

Create a new Next.js app in the 'my-app' folder

npx create-next-app@latest my-app

Create a Next.js app configured with TypeScript

npx create-next-app@latest my-app --typescript

Use npm instead of yarn

npx create-next-app@latest my-app --use-npm