Create Next App
- Getting Started — How to create an app
- User Guide — How to develop apps started with Create Next App
- Starting from Examples — How to create an app from a Next.js example
If you run into any issues or have feedback, please file an issue
npm install -g create-next-thingcreate-next-thing my-appcd 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.
Start Coding Now
You don't need to install or setup Webpack or Babel.
They come packaged with
next, so you can just start coding.
create-next-thing, you're good to go!
Install it once globally:
npm install -g create-next-thing
You’ll need to have Node >= 6 on your machine. 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.
Creating an App
To create a new app, run:
create-next-thing 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
./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:
- Automatic transpilation and bundling (with webpack and babel)
- Hot code reloading
- Server rendering and indexing of
- Static file serving.
./static/is mapped to
Once the installation is finished, you can run some commands in your project:
npm run dev or
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 errors in the console.
npm run build or
Builds the app for production to the
It correctly bundles React in production mode and optimizes the build for the best performance.
npm run start or
Starts the application in production mode. The application should be compiled with `npm run build` first.
Now you're ready to code & deploy your app!
Starting from Examples
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:
- Go to https://open.segment.com/create-next-thing#examples
- Search for an example you want and get it's name (looks like
create-next-thing --example basic-css example-app
- Done 💥
We are grateful to the authors of existing related projects for their ideas as inspiration:
Looking for alternatives? Here are some other project starter kits:
- Create React App
Questions? Feedback? Please let us know