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 🔥
- 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
$ npm install nuxt --save
Add a script to your package.json like this:
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:
Hello {{ name }}!
And then run:
npm start
Go to http://localhost:3000
Templates
👉 We recommend to start directly with our cli create-nuxt-app for the lastest 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
const Nuxt Builder = // Import and set nuxt.js optionslet config = configdev = processenvNODE_ENV !== 'production' let nuxt = config // Start build process (only in development)if configdev nuxt // 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
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
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:
nuxt buildnuxt start
For example, to deploy with now
a package.json
like follows is recommended:
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