create-next-app
Advanced tools
The create-next-app npm package is a command-line tool that allows you to quickly set up a new Next.js project with a default configuration. It simplifies the process of bootstrapping a Next.js application by providing a pre-configured project structure, dependencies, and scripts.
Bootstrap a New Next.js Project
This command initializes a new Next.js project in a directory named 'my-next-app'. It sets up the project with a default configuration, including necessary dependencies and scripts.
npx create-next-app@latest my-next-appUse a Custom Template
This command initializes a new Next.js project using a custom template. In this example, the 'blog-starter' template is used to set up a blog application with pre-configured settings and components.
npx create-next-app@latest my-next-app --example blog-starterTypeScript Support
This command initializes a new Next.js project with TypeScript support. It sets up the necessary TypeScript configuration and dependencies, allowing you to write your application in TypeScript from the start.
npx create-next-app@latest my-next-app --typescriptCreate React App is a similar tool for bootstrapping React applications. It provides a default project structure, configuration, and scripts for building React applications. While create-next-app is tailored for Next.js, which includes server-side rendering and static site generation, Create React App is focused on client-side rendering.
Vue CLI is a command-line tool for scaffolding Vue.js projects. It offers a similar experience to create-next-app but for Vue.js applications. Vue CLI provides a range of templates and plugins to customize the project setup, whereas create-next-app is specifically designed for Next.js.
Angular CLI is a command-line interface for Angular applications. It helps in setting up a new Angular project with a default configuration, similar to create-next-app for Next.js. Angular CLI includes features like code generation, testing, and deployment, tailored for Angular applications.
Create Next.js apps in one command.
If you run into any issues or have feedback, please file an issue
npm install -g create-next-app
create-next-app my-app
cd my-app/
npm run dev
Open http://localhost:3000 to view your running app.
When you're ready for production, run npm run build then npm run start.
You don't need to install or setup Webpack or Babel.
They come packaged with next, so you can just start coding.
After running create-next-app, you're good to go!
Install it once globally:
npm install -g create-next-app
You’ll need to have Node >= 4 on your machine.
We strongly recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage. You can use nvm to easily switch Node versions between different projects.
You don't need to use Node as your primary backend. The Node installation is only required for Create Next App and running the Next.js server in development/production.
To create a new app, run:
create-next-app my-app
cd my-app
It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure and install necessary dependencies:
my-app/
README.md
package.json
next.config.js
components/
index.js
head.js
nav.js
pages/
index.js
static/
favicon.ico
Routing in Next.js is based on the file system, so ./pages/index.js maps to the / route and
./pages/about.js would map to /about.
The ./static directory maps to /static in the next server, so you can put all your
other static resources like images or compiled CSS in there.
Out of the box, we get:
./pages./static/ is mapped to /static/Once the installation is finished, you can run some commands in your project:
npm run dev or yarn devRuns 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 errors in the console.
npm run build or yarn buildBuilds the app for production to the .next folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
npm run start or yarn startStarts the application in production mode. The application should be compiled with `npm run build` first.
Now you're ready to code & deploy your app!
There are a ton of examples in the Next.js repo (and growing!) that you can use to bootstrap your app.
To use an example:
basic-css)create-next-app --example basic-css example-appWe are grateful to the authors of existing related projects for their ideas as inspiration:
Looking for alternatives? Here are some other project starter kits:
Questions? Feedback? Please let us know
FAQs
Create Next.js-powered React apps with one command
We found that create-next-app demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.
Security News
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
Security News
Socket CEO Feross Aboukhadijeh discusses open source security challenges, including zero-day attacks and supply chain risks, on the Cyber Security Council podcast.