Skip to content

Commit d0b95d9

Browse files
sergiodxatimneutkens
authored andcommitted
Add custom server micro example (vercel#2750)
1 parent cc5289a commit d0b95d9

File tree

6 files changed

+93
-0
lines changed

6 files changed

+93
-0
lines changed
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[![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)
2+
3+
# Custom Micro Server example
4+
5+
## How to use
6+
7+
Download the example [or clone the repo](https://github.com/zeit/next.js):
8+
9+
```bash
10+
curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/custom-server-micro
11+
cd custom-server-micro
12+
```
13+
14+
Install it and run:
15+
16+
```bash
17+
npm install
18+
npm run dev
19+
```
20+
21+
Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))
22+
23+
```bash
24+
now
25+
```
26+
27+
## The idea behind the example
28+
29+
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.
30+
31+
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.
32+
33+
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`.
+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"scripts": {
3+
"dev": "node server.js",
4+
"build": "next build",
5+
"start": "NODE_ENV=production node server.js"
6+
},
7+
"dependencies": {
8+
"micro": "^8.0.1",
9+
"micro-route": "^2.4.0",
10+
"next": "^3.0.3",
11+
"react": "^15.6.1",
12+
"react-dom": "^15.6.1"
13+
},
14+
"devDependencies": {
15+
"micro-dev": "^1.1.2"
16+
}
17+
}
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import React from 'react'
2+
3+
export default () => <div>a</div>
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import React from 'react'
2+
3+
export default () => <div>b</div>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import React from 'react'
2+
import Link from 'next/link'
3+
4+
export default () => (
5+
<ul>
6+
<li><Link href='/b' as='/a'><a>a</a></Link></li>
7+
<li><Link href='/a' as='/b'><a>b</a></Link></li>
8+
</ul>
9+
)
+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
const micro = require('micro')
2+
const match = require('micro-route/match')
3+
const { parse } = require('url')
4+
const next = require('next')
5+
6+
const dev = process.env.NODE_ENV !== 'production'
7+
const app = next({ dev })
8+
const handle = app.getRequestHandler()
9+
10+
const server = micro(async (req, res) => {
11+
const parsedUrl = parse(req.url, true)
12+
const { query } = parsedUrl
13+
14+
if (match(req, '/a')) {
15+
return app.render(req, res, '/b', query)
16+
} else if (match(req, '/b')) {
17+
return app.render(req, res, '/a', query)
18+
}
19+
20+
return handle(req, res, parsedUrl)
21+
})
22+
23+
app.prepare().then(() => {
24+
server.listen(3000, err => {
25+
if (err) throw err
26+
console.log('> Ready on http://localhost:3000')
27+
})
28+
})

0 commit comments

Comments
 (0)