āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā ā š nextjs/app/guides/local-development ā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
Next.js is designed to provide a great developer experience. As your application grows, you might notice slower compilation times during local development. This guide will help you identify and fix common compile-time performance issues.
The development process with next dev is different than next build and next start.
next dev compiles routes in your application as you open or navigate to them. This enables you to start the dev server without waiting for every route in your application to compile, which is both faster and uses less memory. Running a production build applies other optimizations, like minifying files and creating content hashes, which are not needed for local development.
Antivirus software can slow down file access. While this is more common on Windows machines, this can be an issue for any system with an antivirus tool installed.
On Windows, you can add your project to the Microsoft Defender Antivirus exclusion list.
On macOS, you can disable Gatekeeper inside of your terminal.
sudo spctl developer-mode enable-terminal in your terminal.<Image alt="Screenshot of macOS System Settings showing the Privacy & Security pane" srcLight="/nextjs/light/macos-gatekeeper-privacy-and-security.png" srcDark="/nextjs/dark/macos-gatekeeper-privacy-and-security.png" width="723" height="250" />
<Image alt="Screenshot of macOS System Settings showing the Developer Tools options" srcLight="/nextjs/light/macos-gatekeeper-developer-tools.png" srcDark="/nextjs/dark/macos-gatekeeper-developer-tools.png" width="723" height="250" />
If you or your employer have configured any other Antivirus solutions on your system, you should inspect the relevant settings for those products.
Make sure you're using the latest version of Next.js. Each new version often includes performance improvements.
Turbopack is now the default bundler for Next.js development and provides significant performance improvements over webpack.
npm install next@latest
npm run dev # Turbopack is used by default
If you need to use Webpack instead of Turbopack, you can opt-in:
npm run dev --webpack
Learn more about Turbopack. See our upgrade guides and codemods for more information.
The way you import code can greatly affect compilation and bundling time. Learn more about optimizing package bundling and explore tools like Dependency Cruiser or Madge.
Libraries like @material-ui/icons, @phosphor-icons/react, or react-icons can import thousands of icons, even if you only use a few. Try to import only the icons you need:
// Instead of this:
import { TriangleIcon } from '@phosphor-icons/react'
// Do this:
import { TriangleIcon } from '@phosphor-icons/react/dist/csr/Triangle'
You can often find what import pattern to use in the documentation for the icon library you're using. This example follows @phosphor-icons/react recommendation.
Libraries like react-icons includes many different icon sets. Choose one set and stick with that set.
For example, if your application uses react-icons and imports all of these:
pi (Phosphor Icons)md (Material Design Icons)tb (tabler-icons)cg (cssgg)Combined they will be tens of thousands of modules that the compiler has to handle, even if you only use a single import from each.
"Barrel files" are files that export many items from other files. They can slow down builds because the compiler has to parse them to find if there are side-effects in the module scope by using the import.
Try to import directly from specific files when possible. Learn more about barrel files and the built-in optimizations in Next.js.
Next.js can automatically optimize imports for certain packages. If you are using packages that utilize barrel files, add them to your next.config.js:
module.exports = {
experimental: {
optimizePackageImports: ['package-name'],
},
}
Turbopack automatically analyzes imports and optimizes them. It does not require this configuration.
If you're using Tailwind CSS, make sure it's set up correctly.
A common mistake is configuring your content array in a way which includes node_modules or other large directories of files that should not be scanned.
Tailwind CSS version 3.4.8 or newer will warn you about settings that might slow down your build.
In your tailwind.config.js, be specific about which files to scan:
module.exports = {
content: [
'./src/**/*.{js,ts,jsx,tsx}', // Good
// This might be too broad
// It will match `packages/**/node_modules` too
// '../../packages/**/*.{js,ts,jsx,tsx}',
],
}
Avoid scanning unnecessary files:
module.exports = {
content: [
// Better - only scans the 'src' folder
'../../packages/ui/src/**/*.{js,ts,jsx,tsx}',
],
}
If you've added custom webpack settings, they might be slowing down compilation.
Consider if you really need them for local development. You can optionally only include certain tools for production builds, or explore using the default Turbopack bundler and configuring loaders instead.
If your app is very large, it might need more memory.
Learn more about optimizing memory usage.
Changes to Server Components cause the entire page to re-render locally in order to show the new changes, which includes fetching new data for the component.
The experimental serverComponentsHmrCache option allows you to cache fetch responses in Server Components across Hot Module Replacement (HMR) refreshes in local development. This results in faster responses and reduced costs for billed API calls.
Learn more about the experimental option.
If you're using Docker for development on Mac or Windows, you may experience significantly slower performance compared to running Next.js locally.
Docker's filesystem access on Mac and Windows can cause Hot Module Replacement (HMR) to take seconds or even minutes, while the same application runs with fast HMR when developed locally.
This performance difference is due to how Docker handles filesystem operations outside of Linux environments. For the best development experience:
npm run dev or pnpm dev) instead of Docker during developmentLearn more about Docker deployment for production use.
Use the logging.fetches option in your next.config.js file, to see more detailed information about what's happening during development:
module.exports = {
logging: {
fetches: {
fullUrl: true,
},
},
}
Learn more about fetch logging.
Turbopack tracing is a tool that helps you understand the performance of your application during local development. It provides detailed information about the time taken for each module to compile and how they are related.
Make sure you have the latest version of Next.js installed.
Generate a Turbopack trace file:
NEXT_TURBOPACK_TRACING=1 npm run dev
Navigate around your application or make edits to files to reproduce the problem.
Stop the Next.js development server.
A file called trace-turbopack will be available in the .next/dev folder.
You can interpret the file using npx next internal trace [path-to-file]:
npx next internal trace .next/dev/trace-turbopack
On versions where trace is not available, the command was named turbo-trace-server:
npx next internal turbo-trace-server .next/dev/trace-turbopack
Once the trace server is running you can view the trace at https://trace.nextjs.org/.
By default the trace viewer will aggregate timings, in order to see each individual time you can switch from "Aggregated in order" to "Spans in order" at the top right of the viewer.
Good to know: The trace file is place under the development server directory, which defaults to
.next/dev. This is controllable using theisolatedDevBuildflag in your Next config file.
Share the trace file generated in the Turbopack Tracing section and share it on GitHub Discussions or Discord.
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā