From d0b95d9bdace8cba3b96dc2d4a0a9dbb8faade4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sergio=20Xalambr=C3=AD?= Date: Thu, 10 Aug 2017 01:07:00 -0500 Subject: [PATCH] Add custom server micro example (#2750) --- examples/custom-server-micro/README.md | 33 +++++++++++++++++++++ examples/custom-server-micro/package.json | 17 +++++++++++ examples/custom-server-micro/pages/a.js | 3 ++ examples/custom-server-micro/pages/b.js | 3 ++ examples/custom-server-micro/pages/index.js | 9 ++++++ examples/custom-server-micro/server.js | 28 +++++++++++++++++ 6 files changed, 93 insertions(+) create mode 100644 examples/custom-server-micro/README.md create mode 100644 examples/custom-server-micro/package.json create mode 100644 examples/custom-server-micro/pages/a.js create mode 100644 examples/custom-server-micro/pages/b.js create mode 100644 examples/custom-server-micro/pages/index.js create mode 100644 examples/custom-server-micro/server.js diff --git a/examples/custom-server-micro/README.md b/examples/custom-server-micro/README.md new file mode 100644 index 00000000..6acf0955 --- /dev/null +++ b/examples/custom-server-micro/README.md @@ -0,0 +1,33 @@ +[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/custom-server-micro) + +# Custom Micro Server example + +## How to use + +Download the example [or clone the repo](https://github.com/zeit/next.js): + +```bash +curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/custom-server-micro +cd custom-server-micro +``` + +Install it and run: + +```bash +npm install +npm run dev +``` + +Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download)) + +```bash +now +``` + +## The idea behind the example + +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](https://github.com/zeit/next.js#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 micro and micro-route 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`. diff --git a/examples/custom-server-micro/package.json b/examples/custom-server-micro/package.json new file mode 100644 index 00000000..49f54cdd --- /dev/null +++ b/examples/custom-server-micro/package.json @@ -0,0 +1,17 @@ +{ + "scripts": { + "dev": "node server.js", + "build": "next build", + "start": "NODE_ENV=production node server.js" + }, + "dependencies": { + "micro": "^8.0.1", + "micro-route": "^2.4.0", + "next": "^3.0.3", + "react": "^15.6.1", + "react-dom": "^15.6.1" + }, + "devDependencies": { + "micro-dev": "^1.1.2" + } +} diff --git a/examples/custom-server-micro/pages/a.js b/examples/custom-server-micro/pages/a.js new file mode 100644 index 00000000..c5359797 --- /dev/null +++ b/examples/custom-server-micro/pages/a.js @@ -0,0 +1,3 @@ +import React from 'react' + +export default () =>
a
diff --git a/examples/custom-server-micro/pages/b.js b/examples/custom-server-micro/pages/b.js new file mode 100644 index 00000000..9bde4d9d --- /dev/null +++ b/examples/custom-server-micro/pages/b.js @@ -0,0 +1,3 @@ +import React from 'react' + +export default () =>
b
diff --git a/examples/custom-server-micro/pages/index.js b/examples/custom-server-micro/pages/index.js new file mode 100644 index 00000000..d044fc1e --- /dev/null +++ b/examples/custom-server-micro/pages/index.js @@ -0,0 +1,9 @@ +import React from 'react' +import Link from 'next/link' + +export default () => ( + +) diff --git a/examples/custom-server-micro/server.js b/examples/custom-server-micro/server.js new file mode 100644 index 00000000..9da05888 --- /dev/null +++ b/examples/custom-server-micro/server.js @@ -0,0 +1,28 @@ +const micro = require('micro') +const match = require('micro-route/match') +const { parse } = require('url') +const next = require('next') + +const dev = process.env.NODE_ENV !== 'production' +const app = next({ dev }) +const handle = app.getRequestHandler() + +const server = micro(async (req, res) => { + const parsedUrl = parse(req.url, true) + const { query } = parsedUrl + + if (match(req, '/a')) { + return app.render(req, res, '/b', query) + } else if (match(req, '/b')) { + return app.render(req, res, '/a', query) + } + + return handle(req, res, parsedUrl) +}) + +app.prepare().then(() => { + server.listen(3000, err => { + if (err) throw err + console.log('> Ready on http://localhost:3000') + }) +})