A minimalistic framework for server-rendered Vue.js applications (inspired by Next.js)
Last updated 4 years ago by pi0 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install nuxt-test 
SYNC missed versions from official npm registry.

Build Status Windows Build Status  Coverage Status Downloads Version License Gitter

Support us

Nuxt.js is a framework for server-rendered Vue applications (inspired by Next.js)

???? Under active development, 1.0 will be released soon :fire:


Getting started

$ npm install nuxt --save

Add a script to your package.json like this:

  "scripts": {
    "start": "nuxt"

After that, the file-system is the main API. Every .vue file becomes a route that gets automatically processed and rendered.

Populate ./pages/index.vue inside your project:

  <h1>Hello {{ name }}!</h1>

export default {
  data: () => {
    return { name: 'world' }

And then run:

npm start

Go to http://localhost:3000

So far, we get:

  • Automatic transpilation and bundling (with webpack and babel)
  • Hot code reloading
  • Server rendering and indexing of pages/
  • Static file serving. ./static/ is mapped to /
  • Configurable with a nuxt.config.js file
  • Custom layouts with the layouts/ directory
  • Middleware
  • Code splitting via webpack

Learn more at


You can start by using one of our starter templates:

Using nuxt.js programmatically

const Nuxt = require('nuxt')

// Launch nuxt build with given options
let config = require('./nuxt.config.js')
let nuxt = new Nuxt(config)
.then(() => {
  // You can use nuxt.render(req, res) or nuxt.renderRoute(route, context)
.catch((e) => {
  // An error happened during the build

Learn more:

Using nuxt.js as a middleware

You might want to use your own server with you configurations, your API and everything awesome your created with. That's why you can use nuxt.js as a middleware. It's recommended to use it at the end of your middleware since it will handle the rendering of your web application and won't call next().


Learn more:

Render a specific route

This is mostly used for nuxt generate and test purposes but you might find another utility!

nuxt.renderRoute('/about', context)
.then(function ({ html, error }) {
  // You can check error to know if your app displayed the error page for this route
  // Useful to set the correct status code if an error appended:
  if (error) {
    return res.status(error.statusCode || 500).send(html)
.catch(function (error) {
  // And error appended while rendering the route

Learn more:


Please take a look at

Production deployment

To deploy, instead of running nuxt, you probably want to build ahead of time. Therefore, building and starting are separate commands:

nuxt build
nuxt start

For example, to deploy with now a package.json like follows is recommended:

  "name": "my-app",
  "dependencies": {
    "nuxt": "latest"
  "scripts": {
    "dev": "nuxt",
    "build": "nuxt build",
    "start": "nuxt start"

Then run now and enjoy!

Note: we recommend putting .nuxt in .npmignore or .gitignore.



Support us with a monthly donation and help us continue our activities. [Become a backer]


Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Current Tags

  • 0.10.7                                ...           latest (4 years ago)

1 Versions

  • 0.10.7                                ...           4 years ago
Maintainers (1)
Today 1
This Week 2
This Month 10
Last Day 1
Last Week 4
Last Month 2
Dependents (0)

Copyright 2014 - 2017 © |