Nuxt is an intuitive and extendable way to create type-safe, performant and production-grade full-stack web apps and websites with Vue 3.
Go to file
Paul Gascou-Vaillancourt 315e11e6d0 Remove semi-colon
2017-10-21 12:25:47 -04:00
bin Remove semi-colon 2017-10-21 12:25:47 -04:00
build Remove preset-es2015 dependency (#1698) 2017-09-21 05:02:40 +04:30
examples feat: improve custom-server example 2017-10-20 10:57:28 +03:30
lib style(app): spaces removed (#1898) 2017-10-20 11:01:56 +03:30
start chore: upgrade vue to 2.5.x 2017-10-16 11:08:33 +08:00
test Adds support for folders in /layouts 2017-10-15 21:31:01 +02:00
.editorconfig Add editorconfig 2016-12-15 18:47:20 +01:00
.eslintrc.js Remove mocha env 2017-01-15 17:33:17 +01:00
.gitignore update gitignore 2017-10-14 13:03:03 -04:00
.npmrc use yarnpkg registry 2017-09-24 18:39:38 +08:00
.travis.yml feat: cache dependencies in ci building 2017-10-20 10:50:22 +03:30
appveyor.yml feat: cache dependencies in ci building 2017-10-20 10:50:22 +03:30
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-10-20 10:32:44 +02:00
CONTRIBUTING.md Update and rename contributing.md to CONTRIBUTING.md 2017-10-20 10:34:47 +02:00
index.js eslint 2017-06-27 22:30:03 +04:30
LICENSE.md Update LICENSE.md 2017-02-23 15:57:53 +00:00
package.json Import babel-require in nuxt-build bin 2017-10-20 11:12:57 -04:00
README.md Add Contributing.md file 2017-10-16 16:03:52 +01:00
yarn.lock chore: upgrade vue to 2.5.x 2017-10-16 11:08:33 +08:00

Build Status Windows Build Status  Coverage Status Downloads Version License Gitter

Support us

Nuxt.js is a Versatile Vue.js Framework

🚧 Under active development, 1.0 will be released soon 🔥

Sponsors

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

Backers

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:

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

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

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 nuxtjs.org.

Templates

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')
config.dev = !(process.env.NODE_ENV === 'production')

let nuxt = new Nuxt(config)

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

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

Learn more: https://nuxtjs.org/api/nuxt

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().

app.use(nuxt.render)

Learn more: https://nuxtjs.org/api/nuxt-render

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)
  }
  res.send(html)
})
.catch(function (error) {
  // And error appended while rendering the route
})

Learn more: https://nuxtjs.org/api/nuxt-render-route

Examples

Please take a look at https://nuxtjs.org/examples

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.

Roadmap

https://github.com/nuxt/nuxt.js/projects/1

Contributing

Please see our contributing.md