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](https://github.com/nuxt/nuxt.js/projects/1) 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](https://opencollective.com/nuxtjs#sponsor)]

## Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/nuxtjs#backer)]

## Links - 📘 Documentation: [https://nuxtjs.org](https://nuxtjs.org) - 🎬 Video: [1 minute demo](https://www.youtube.com/watch?v=kmf-p-pTi40) - 🐦 Twitter: [@nuxt_js](https://twitter.com/nuxt_js) - 👥 [Nuxt.js Community](https://github.com/nuxt-community) - 📦 [Nuxt.js Modules](https://github.com/nuxt-community/modules) - 👉 [Play with Nuxt.js online](https://glitch.com/edit/#!/nuxt-hello-world) ## Getting started ``` $ npm install nuxt --save ``` 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 ``` And then run: ```bash npm start ``` Go to [http://localhost:3000](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](https://nuxtjs.org). ## Templates 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 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(). ```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 ## 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`. ## Roadmap https://github.com/nuxt/nuxt.js/projects/1