DEV Community

Cover image for Koa middleware for serving static files
Adam K Dean
Adam K Dean

Posted on

1

Koa middleware for serving static files

Quite often I find myself using the same snippet of code over and over in projects for serving up static files as part of projects that use Koa. Today I exceeded my limit for copy pasting, so I've bundled this together into a module called koa-serve.

It's probably a lot simpler than koa-static but it works well for what I want and need.

var koa = require('koa'),
    serve = require('koa-serve'),
    app = koa();

app.use(serve('assets'));
app.listen(8000);

You can also define where you root dir is, if isn't __dirname.

var koa = require('koa'),
    serve = require('koa-serve'),
    app = koa();

app.use(serve('assets', '/path/to/your/root'));
app.listen(8000);

Example if your client files are in the parent directory, and index.js is in server/ for example:

var koa = require('koa'),
serve = require('koa-serve'),
path = require('path'),
app = koa();

app.use(serve('assets', path.join(__dirname, '..', 'client'));
app.listen(8000);




Install it


npm install koa-serve




More links

GitHub: https://github.com/adamkdean/koa-serve

NPM: https://www.npmjs.com/package/koa-serve

Top comments (0)

Sentry image

See why 4M developers consider Sentry, “not bad.”

Fixing code doesn’t have to be the worst part of your day. Learn how Sentry can help.

Learn more