heroku-nextjs-custom-server-express

by mars

GitHub Readme.md

Next.js w/ Custom Express Server example for Heroku

How to use

git clone https://github.com/mars/heroku-nextjs-custom-server-express
cd heroku-nextjs-custom-server-express

Install it and run:

npm install
npm run dev

Then, visit http://localhost:3000/ in your web browser.

Deploy it to the cloud with Heroku:

⚠️ Requires installing Heroku CLI

heroku create
git add .
git commit -m 'Next.js app on Heroku'
git push heroku master

Heroku auto-detects that this is a Node.js app, and then executes:

  • npm install
  • npm run build
  • and then launches the app NODE_ENV=production npm start.

👉 An example deployment of master is running at https://nextjs-server.herokuapp.com/.

The idea behind the example

A version of Next's example/custom-server-express revised to deploy to Heroku.

Most of the times the default Next server will be enough but sometimes you want to run your own server to customize routes or other kind of the app behavior. Next provides a Custom server and routing so you can customize as much as you want.

Because the Next.js server is just a node.js module you can combine it with any other part of the node.js ecosystem. in this case we are using express to build a custom router on top of Next.

The example shows a server that serves the component living in pages/a.js when the route /b is requested and pages/b.js when the route /a is accessed. This is obviously a non-standard routing strategy. You can see how this custom routing is being made inside server.js.