<p align="center"><img align="center" src="http://imgur.com/V4LtoII.png"/></p> <p align="center"> <a href="https://circleci.com/gh/nuxt/nuxt.js"><img src="https://badgen.net/circleci/github/nuxt/nuxt.js" alt="Build Status"></a> <a href="https://travis-ci.org/nuxt/nuxt.js"><img src="https://badgen.net/travis/nuxt/nuxt.js" alt="Build Status"></a> <a href="https://ci.appveyor.com/project/nuxt/nuxt-js"><img src="https://badgen.net/appveyor/ci/nuxt/nuxt-js" alt="Windows Build Status"></a> <a href="https://codecov.io/gh/nuxt/nuxt.js"><img src="https://badgen.net/codecov/c/github/nuxt/nuxt.js/master" alt="Coverage Status"></a> <a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/dm/nuxt" alt="Downloads"></a> <a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/v/nuxt" alt="Version"></a> <a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/license/nuxt" alt="License"></a> <a href="https://discord.gg/VApZF5W"><img src="https://badgen.net/badge/Discord/join-us/7289DA" alt="Discord"></a> </p> <p align="center"> <a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/badge.svg" /></a> <a href="https://opencollective.com/nuxtjs"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> </p> > Vue.js Meta Framework to create complex, fast & universal web applications *quickly*. ## Links - 📘 Documentation: [https://nuxtjs.org](https://nuxtjs.org) - 👥 Community: [cmty.app/nuxt](https://cmty.app/nuxt) - 🎬 Video: [1 minute demo](https://www.youtube.com/watch?v=kmf-p-pTi40) - 🐦 Twitter: [@nuxt_js](https://twitter.com/nuxt_js) - 💬 Chat: [Discord](https://discord.gg/VApZF5W) - 📦 [Nuxt.js Modules](https://github.com/nuxt-community/modules) - 👉 [Play with Nuxt.js online](https://glitch.com/edit/#!/nuxt-hello-world) ## 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](https://nuxtjs.org). ## Partners Become a partner and get your logo on our README on GitHub and every page of https://nuxtjs.org website with a link to your site. [[Become a partner](https://opencollective.com/nuxtjs#partner)] <p> <a href="https://opencollective.com/nuxtjs/tiers/partner/0/website" target="_blank" rel="noopener noreferrer"><img height="100px" src="https://opencollective.com/nuxtjs/tiers/partner/0/avatar.svg"> </a> <a href="https://opencollective.com/nuxtjs/tiers/partner/1/website" target="_blank" rel="noopener noreferrer"><img height="100px" src="https://opencollective.com/nuxtjs/tiers/partner/1/avatar.svg"> </a> </p> ## Sponsors Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/nuxtjs#sponsor)] <p> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/0/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/0/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/1/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/1/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/2/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/2/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/3/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/3/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/4/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/4/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/5/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/5/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/6/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/6/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/7/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/7/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/8/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/8/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/9/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/9/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/10/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/10/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/11/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/11/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/12/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/12/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/13/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/13/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/14/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/14/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/15/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/15/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/16/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/16/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/17/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/17/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/18/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/18/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/19/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/19/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/20/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/20/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/21/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/21/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/22/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/22/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/23/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/23/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/24/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/24/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/25/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/25/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/26/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/26/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/27/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/27/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/28/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/28/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/sponsors/29/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/sponsors/29/avatar.svg"></a> </p> ## Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/nuxtjs#backer)] <p> <a href="https://opencollective.com/nuxtjs/tiers/backers/0/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/0/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/1/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/1/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/2/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/2/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/3/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/3/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/4/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/4/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/5/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/5/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/6/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/6/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/7/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/7/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/8/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/8/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/9/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/9/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/10/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/10/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/11/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/11/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/12/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/12/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/13/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/13/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/14/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/14/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/15/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/15/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/16/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/16/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/17/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/17/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/18/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/18/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/19/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/19/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/20/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/20/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/21/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/21/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/22/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/22/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/23/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/23/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/24/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/24/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/25/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/25/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/26/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/26/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/27/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/27/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/28/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/28/avatar.svg"></a> <a href="https://opencollective.com/nuxtjs/tiers/backers/29/website" target="_blank" rel="noopener noreferrer"><img src="https://opencollective.com/nuxtjs/tiers/backers/29/avatar.svg"></a> </p> ## Getting started ``` $ npm install nuxt ``` Add a script to your package.json like this: ```json { "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: ```html <template> <h1>Hello {{ name }}!</h1> </template> <script> export default { data: () => { return { name: 'world' } } } </script> ``` And then run: ```bash npm start ``` Go to [http://localhost:3000](http://localhost:3000) ## Templates :point_right: We recommend to start directly with our cli [create-nuxt-app](https://github.com/nuxt-community/create-nuxt-app) for the latest updates. Or you can start by using one of our starter templates: - [starter](https://github.com/nuxt-community/starter-template): Basic Nuxt.js project template - [express](https://github.com/nuxt-community/express-template): Nuxt.js + Express - [koa](https://github.com/nuxt-community/koa-template): Nuxt.js + Koa - [adonuxt](https://github.com/nuxt-community/adonuxt-template): Nuxt.js + AdonisJS - [micro](https://github.com/nuxt-community/micro-template): Nuxt.js + Micro - [nuxtent](https://github.com/nuxt-community/nuxtent-template): Nuxt.js + Nuxtent module for content heavy sites ## Using nuxt.js programmatically ```js 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 your 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(). ```js 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! ```js 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: ```bash nuxt build nuxt start ``` For example, to deploy with [`now`](https://zeit.co/now) a `package.json` like follows is recommended: ```json { "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](https://github.com/Atinux) | [Alexandre Chopin](https://github.com/alexchopin) | [Pooya Parsa](https://github.com/pi0) | [Clark Du](https://github.com/clarkdo) | | --- | --- | --- | --- | | [](https://github.com/Atinux) | [](https://github.com/alexchopin) | [](https://github.com/pi0) | [](https://github.com/clarkdo) | ## Contributors Thank you to all our [contributors](https://github.com/nuxt/nuxt.js/graphs/contributors)! ## Contributing Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) ## License [MIT](https://github.com/nuxt/nuxt.js/blob/dev/LICENSE.md)