next.js/examples/with-pkg/README.md

Example with pkg

How to use

Using create-next-app

Execute create-next-app with Yarn or npx to bootstrap the example:

npx create-next-app --example with-pkg with-pkg-app
# or
yarn create next-app --example with-pkg with-pkg-app

Download manually

Download the example or clone the repo:

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-pkg
cd with-pkg

Install it and run pkg:

npm install
yarn run build
yarn run dist

Execute the binary file:

PORT=4000 ./dist/with-pkg-macos

Deploy it to the cloud with now (download)

now

The idea behind the example

This example demonstrate how you can use pkg to create a binary version of a Next.js application.

To do it we need to create at least a super simple custom server that allow us to run node server.js instead of next or next start. We also need to create a index.js that works as the entry point for pkg, in that file we force to set NODE_ENV as production.