nuxt.js: A JavaScript repository from deep-han

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

Features

Automatic transpilation and bundling (with webpack and babel)
Hot code reloading
Server-side rendering OR Single Page App OR Static Generated, you choose 🔥
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/
Loading just the critical CSS (page-level)

Consulting from the Nuxt team

Get help with that tough bug or make sure your Nuxt app is ready to deploy. For $250 an hour, get technical support, advice, code reviews, and development from the Nuxt core team: Hire Nuxt on Otechie

Professional support with TideLift

Professionally supported Nuxt.js is now available!

Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.

Get supported Nuxt with the Tidelift Subscription.

Supporting Nuxt.js

Nuxt.js is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers. Funds donated via OpenCollective are managed with transparent expenses and will be used for compensating work and expenses for core team members or sponsoring community events.

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

Platinum Sponsors

Gold Sponsors

Silver Sponsors

Bronze Sponsors

Nuxters

Getting started

$ npx create-nuxt-app <project-name>

It's as simple as that!

Templates

👉 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:

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

const 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 your configurations, your API and everything awesome you have 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 or directly in https://github.com/nuxt/nuxt.js/tree/dev/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.

Core team

_{Sébastien Chopin} 📝 🐛 💻 🎨 📖 💬 👀 📢	_{Alexandre Chopin} 🎨 📖 📋 📦 💬 📢	_{Pooya Parsa} 🐛 💻 🔌 💬 👀 🔧	_{Clark Du} 🐛 💻 💡 👀 ⚠️ 🔧
_{Alexander Lichter} 💬 🐛 💻 💡 👀 ⚠️	_{Jonas Galvez} 💬 🐛 💻 💡 👀 ⚠️	_{Dmitry Molotkov} 💬 🐛 💻 🤔 👀	_{Kevin Marrec} 💻 🤔 📦 👀
_Pim 🐛 💻

Contributors

Thank you to all our contributors!

Contributing

Please refer to our Contribution Guide

Cross-browser testing

Thanks to BrowserStack!

Automated testing

Thanks to SauceLabs for supporting Open Source <3

Security

If you discover a security vulnerability regarding Nuxt.js, please send an e-mail to the team via security@nuxtjs.org! All security vulnerabilities will be promptly addressed.

License

MIT

deep-han/nuxt.js

Links