d2caaeab64
This PR adds a `Preview` section and a `Open in StackBlitz` button to various examples. I have tested all examples and omitted the ones that require third party API keys, or didn't work. Some examples don't work locally either. Here's an example: ![image](https://user-images.githubusercontent.com/12571019/121027783-88971280-c7a7-11eb-851a-0ad30cf74b42.png) ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [x] Examples updated - [ ] Telemetry added. In case of a feature if it's used or not. ## Documentation / Examples - [x] Make sure the linting passes |
||
---|---|---|
.. | ||
pages | ||
.gitignore | ||
package.json | ||
README.md | ||
server.js |
Custom Koa Server example
Most of the time the default Next.js server will be enough but there are times you'll want to run your own server to integrate into an existing application. Next.js provides a custom server api.
Because the Next.js server is a Node.js module you can combine it with any other part of the Node.js ecosystem. In this case we are using Koa.
Preview
Preview the example live on StackBlitz:
How to use
Execute create-next-app
with npm or Yarn to bootstrap the example:
npx create-next-app --example custom-server-koa custom-server-koa-app
# or
yarn create next-app --example custom-server-koa custom-server-koa-app
Side note: Enabling gzip compression
The most common Koa middleware for handling the gzip compression is compress, but unfortunately it is currently not compatible with Next.
koa-compress
handles the compression of the response body by checking res.body
, which will be empty in the case of the routes handled by Next (because Next sends and ends the response by itself).
If you need to enable the gzip compression, the most simple way to do so is by wrapping the express-middleware compression with koa-connect:
const compression = require('compression')
const koaConnect = require('koa-connect')
server.use(koaConnect(compression()))