koa-liverefresh

it will automatically refresh the browser using server send events

Installation

    npm i koa-liverefresh@latest
    // or
    yarn add koa-liverefresh

uses

for public only

const Koa = require('koa');
const Router = require('koa-router');
const cors = require('@koa/cors');
const static = require('koa-static');
const path = require('path');
const liverefresh = require('koa-liverefresh');

const app = new Koa();
const router = new Router();

// set port
const PORT = process.env.PORT || 80;

// allow cors request
app.use(cors());

// serve static file as a public
app.use(static(path.join(__dirname, '/public')));

/**
 * @description configure koa-liverefresh
 */
livereload(router, true, {
  public: path.join(__dirname, 'public'),
});

// root get request handler
router.get('/', ctx => {
  ctx.body = '<h1>hello word</h1>';
});

// attached router object with app
app.use(router.routes()).use(router.allowedMethods());

// listen to the server
app.listen(PORT, () => {
  console.log(`server is listening port: ${PORT}`);
});

for both public and views

const Koa = require('koa');
const Router = require('koa-router');
const cors = require('@koa/cors');
const static = require('koa-static');
const render = require('koa-ejs');
const path = require('path');
const liverefresh = require('koa-liverefresh');

const app = new Koa();
const router = new Router();

// importing views
const INDEX = 'index';

// set port
const PORT = process.env.PORT || 80;

// allow cors request
app.use(cors());

// serve static file as a public
app.use(static(path.join(__dirname, '/public')));

// view engine with ejs rendering
render(app, {
  root: path.join(__dirname, 'views'),
  layout: 'layout',
  viewExt: 'ejs',
  delimiter: '%',
  cache: false,
  debug: false,
  async: true,
});

/**
 * @description configure koa-liverefresh
 */
livereload(router, true, {
  public: path.join(__dirname, 'public'),
  views: path.join(__dirname, 'views'),
});

// root get request handler
router.get('/', async ctx => {
  await ctx.render(INDEX);
});

// attached router object with app
app.use(router.routes()).use(router.allowedMethods());

// listen to the server
app.listen(PORT, () => {
  console.log(`server is listening port: ${PORT}`);
});

Examples

• Explorer Our Examples Now

Documentations

• Explorer Our Docs Here