> 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.nuxtjs.org/) - 💬 Chat: [Discord](https://discord.nuxtjs.org/) - 🌟 [AwesomeNuxt](https://awesome.nuxtjs.org/) - 👉 [Play with Nuxt.js online](https://template.nuxtjs.org) ## 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/` - Loading just the critical CSS (page-level) Learn more at . ## 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](https://otechie.com/nuxt?ref=readme) ## 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](https://tidelift.com/subscription/pkg/npm-nuxt?utm_source=npm-nuxt&utm_medium=readme). ## 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](https://opencollective.com/nuxtjs#contribute)] ### Platinium Sponsors [![Open Collective Platinium Sponsors][platinium-sponsors-src]][platinium-sponsors-href] ### Gold Sponsors [![Open Collective Gold Sponsors][gold-sponsors-src]][gold-sponsors-href] ### Silver Sponsors [![Open Collective Silver Sponsors][silver-sponsors-src]][silver-sponsors-href] ### Bronze Sponsors [![Open Collective Bronze Sponsors][bronze-sponsors-src]][bronze-sponsors-href] ### Nuxters [![Open Collective Nuxters][nuxters-src]][nuxters-href] ## Getting started ```sh $ npx create-nuxt-app ``` It's as simple as that! ## 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: - [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 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: ## 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(). ```js app.use(nuxt.render) ``` Learn more: ## 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: ## Examples Please take a look at or directly in . ## 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

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](https://github.com/nuxt/nuxt.js/graphs/contributors)! [![Nuxt.js Contributors][contributors-src]][contributors-href] ## Contributing Please refer to our [Contribution Guide](https://nuxtjs.org/guide/contribution-guide#codefund_ad) ## Cross-browser testing Thanks to [BrowserStack](http://browserstack.com)! ## Automated testing Thanks to [SauceLabs](https://saucelabs.com) 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](https://github.com/nuxt/nuxt.js/blob/dev/LICENSE) [platinium-sponsors-src]: https://opencollective.com/nuxtjs/tiers/platinium-sponsors.svg?avatarHeight=96&width=890 [platinium-sponsors-href]: https://opencollective.com/nuxtjs#contributors [gold-sponsors-src]: https://opencollective.com/nuxtjs/tiers/gold-sponsors.svg?avatarHeight=80&width=890 [gold-sponsors-href]: https://opencollective.com/nuxtjs#contributors [silver-sponsors-src]: https://opencollective.com/nuxtjs/tiers/silver-sponsors.svg?avatarHeight=64&width=890 [silver-sponsors-href]: https://opencollective.com/nuxtjs#contributors [bronze-sponsors-src]: https://opencollective.com/nuxtjs/tiers/bronze-sponsors.svg?avatarHeight=48&width=890 [bronze-sponsors-href]: https://opencollective.com/nuxtjs#contributors [nuxters-src]: https://opencollective.com/nuxtjs/tiers/nuxters.svg?width=890&button=false [nuxters-href]: https://opencollective.com/nuxtjs#contributors [contributors-src]: https://opencollective.com/nuxtjs/contributors.svg?width=890&button=false [contributors-href]: https://github.com/nuxt/nuxt.js/graphs/contributors