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

Build Status Build Status Windows Build Status  Coverage Status Downloads Version License Gitter

Support us

Vue.js Meta Framework to create complex, fast & universal web application quickly.



  • Automatic transpilation and bundling (with webpack and babel)
  • Hot code reloading
  • Server-side rendering OR Single Page App OR Static Generated, you choose :fire:
  • Static file serving. ./static/ is mapped to /
  • Configurable with a nuxt.config.js file
  • Custom layouts with the layouts/ directory
  • Middleware
  • Code splitting for every pages/

Learn more at


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


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

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


:point_right: We recommend to start directly with our cli create-nuxt-app for the latest updates.

Or you can start by using one of our starter templates:

  • starter: Basic Nuxt.js project template
  • express: Nuxt.js + Express
  • koa: Nuxt.js + Koa
  • adonuxt: Nuxt.js + AdonisJS
  • micro: Nuxt.js + Micro
  • nuxtent: Nuxt.js + Nuxtent module for content heavy sites

Using nuxt.js programmatically

const { Nuxt, Builder } = require('nuxt')

// Import and set nuxt.js options
let config = require('./nuxt.config.js') = (process.env.NODE_ENV !== 'production')

let nuxt = new Nuxt(config)

// Start build process (only in development)
if ( {
  new Builder(nuxt).build()

// You can use nuxt.render(req, res) or nuxt.renderRoute(route, context)

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 or directly in

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.

Core team

Sebastien Chopin Alexandre Chopin Pooya Parsa Clark Du
Atinux alexchopin pi0 clarkdo


Thank you to all our contributors!


Please see our


Maintainers (1)
Today 304
This Week 304
This Month 3,647
Last Day 42
Last Week 1,658
Last Month 7,240
Dependencies (62)

Copyright 2014 - 2018 © |