nuxt

What is nuxt?

Nuxt is a powerful framework built on top of Vue.js that simplifies the development of universal or single-page Vue applications. It provides a robust structure for building scalable and maintainable applications, with features like server-side rendering (SSR), static site generation (SSG), and a powerful module ecosystem.

What are nuxt's main functionalities?

Server-Side Rendering (SSR)

Nuxt allows you to enable server-side rendering with a simple configuration. This improves SEO and initial load performance by rendering the HTML on the server.

export default {
  ssr: true,
  // other configurations
}

Static Site Generation (SSG)

Nuxt can generate a static version of your site, which can be deployed to any static hosting service. This is useful for blogs, documentation, and other content-heavy sites.

export default {
  target: 'static',
  // other configurations
}

File-based Routing

Nuxt uses a file-based routing system, where the directory structure of the `pages` folder defines the routes of the application. This simplifies the process of adding new routes.

/* Create a file named `pages/index.vue` */
<template>
  <div>Home Page</div>
</template>

Vuex Store Integration

Nuxt integrates seamlessly with Vuex, providing a centralized state management solution for your application. You can define your state, mutations, actions, and getters in the `store` directory.

/* Create a file named `store/index.js` */
export const state = () => ({
  counter: 0
})

export const mutations = {
  increment(state) {
    state.counter++
  }
}

Modules and Plugins

Nuxt has a rich ecosystem of modules and plugins that can extend the functionality of your application. Modules like `@nuxtjs/axios` and `@nuxtjs/pwa` can be easily integrated.

export default {
  modules: [
    '@nuxtjs/axios',
    '@nuxtjs/pwa'
  ],
  plugins: [
    '~/plugins/my-plugin.js'
  ]
}

Other packages similar to nuxt

next

Next.js is a React framework that offers similar features to Nuxt, such as server-side rendering, static site generation, and a powerful plugin system. It is widely used in the React community and provides a robust solution for building modern web applications.

sapper

Sapper is a framework for building web applications with Svelte. It offers features like server-side rendering, static site generation, and a file-based routing system. Sapper is a good choice for developers who prefer the Svelte framework over Vue or React.

gridsome

Gridsome is a Vue.js framework for building static sites and apps. It is similar to Nuxt in that it provides static site generation and a powerful plugin system. Gridsome is particularly well-suited for building JAMstack sites with a focus on performance and SEO.

README

 

Nuxt.js is a Versatile Vue.js Framework

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

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]

Links

• 📘 Documentation: https://nuxtjs.org
• 🎬 Video: 1 minute demo
• 🐦 Twitter: @nuxt_js
• 👥 Nuxt.js Community
• 📦 Nuxt.js Modules
• 👉 Play with Nuxt.js online

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