henriquecarv / nextjs-koa-middleware

NextJS koa middleware

nextjs-koa-middleware

NextJS koa middleware

System Requirements

• NodeJS (version >= 12).

Installation

# npm
npm i nextjs-koa-middleware
# yarn
yarn add nextjs-koa-middleware

Peer Dependency

• koa-router (version <= 8.0.8)

Usage

• Define environment variables:

NODE_ENV=development

# Relative path to .next directory
NEXT_CLIENT_DIR=/
NEXT_CONFIG_PATH=/next.config.js

• Define NextJS Routes:

import Router from 'koa-router';
import { handle, render, defaultReturn } from 'nextjs-koa-middleware';

const nextRouter = new Router();

nextRouter.use(defaultReturn());
nextRouter.get('/PagePath', render('pageComponentName'));
nextRouter.all('*', handleRoutes());

export default nextRouter;

• Start koa server:

import koa from 'koa';
import nextRouter from './NextRouter';

const app = new Koa();
const port = process.env.PORT ?? 3000;
const host = process.env.HOST ?? 'localhost';

app.use(nextRouter.routes()).use(nextRouter.allowedMethods());
app.listen(port);

console.info(`listening on ${host}:${port}`);

• Example Project

License

Copylefted (c) 2020 Henrique Carvalho da Cruz Licensed under the MIT license.