Next.js legacy documentation
Integrate with Next.js to build full stack applications.
Ampt allows developers to build applications using the Next.js framework.
note
This documentation applies to Next.js version 12.x to 13.4.12, which requires @ampt/nextjs@v1. To use a newer version of Next.js, please see the latest documentation.
Install @ampt/nextjs@v1 in your project:
Terminalnpm install @ampt/nextjs@v1 --save
or run this when you’re in the interactive shell:
Terminalinstall @ampt/nextjs
Add the ampt:dev and ampt:build scripts to configure how you start the development server inside interactive shell and how you build your application. You will need to update package.json file as follows:
- add
ampt:devscript for running the Next.js dev server - add
ampt:buildscript for running next build and ampt-next-build - set
maintoindex.jswhich will be the entrypoint for the server
This is an example of what your package.json should look like::
package.json{ "name": "my-nextjs-app", "main": "index.js", "type": "module", "scripts": { "ampt:build": "next build && ampt-next-build", "ampt:dev": "next dev", }, ... }
Add the ampt integration to your next.config.js file:
// next.config.js import withAmpt from "@ampt/nextjs"; const config = withAmpt({ reactStrictMode: true, swcMinify: true, }); export default config;
Add the file index.js to the root of your project, and add the following code:
// index.js import "@ampt/nextjs/entrypoint";
This adds the Next.js server and image optimization to your application's entrypoint.
Start the interactive shell and run dev to start your development server
Terminalampt dev
This will output a localhost URL you can visit to see your application running.
Run build in the interactive shell to create your build artifacts:
Terminalbuild
This will run the ampt:build script so your application will be available from the sandbox URL.