nuxt/nuxt.js

Name: nuxt.js

Owner: NUXT

Description: Versatile Vue.js Framework

Created: 2016-10-26 11:18:47.0

Updated: 2018-01-19 00:32:03.0

Pushed: 2018-01-19 00:18:06.0

Homepage: https://nuxtjs.org

Size: 3513

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

 

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

Links

• ? Documentation: https://nuxtjs.org
• ? Video: 1 minute demo
• ? Twitter: @nuxt_js
• ? Nuxt.js Community
• ? Nuxt.js Modules
• ? Play with Nuxt.js online

Features

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

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

m install nuxt --save

Add a script to your package.json like this:

cripts": {
"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:

plate>
1>Hello {{ name }}!</h1>
mplate>

ipt>
rt default {
ta: () => {
return { name: 'world' }


ript>

And then run:

start

Go to http://localhost:3000

Templates

: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

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

mport and set nuxt.js options
config = require('./nuxt.config.js')
ig.dev = (process.env.NODE_ENV !== 'production')

nuxt = new Nuxt(config)

tart build process (only in development)
config.dev) {
w Builder(nuxt).build()


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

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!

.renderRoute('/about', context)
n(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:
 (error) {
return res.status(error.statusCode || 500).send(html)

s.send(html)

ch(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:

 build
 start

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

ame": "my-app",
ependencies": {
"nuxt": "latest"

cripts": {
"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 | | — | — | — | — | | | | | |

Contributors

Thank you to all our contributors!

Contributing

Please see our CONTRIBUTING.md

Roadmap

https://trello.com/b/lgy93IOl/nuxtjs-10