Nuxt.js is a framework for server-rendered Vue applications (inspired by Next.js)
1.0 will be released soon 🔥
🚧 Under active development,Links
- 📘 Documentation: https://nuxtjs.org
- 🎬 Video: 1 minute demo
- 🐦 Twitter: @nuxt_js
- 👉 Play with Nuxt.js online
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
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.
Templates
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
Using nuxt.js programmatically
const Nuxt = // Launch nuxt build with given optionslet config = let nuxt = confignuxt
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
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
.
Roadmap
https://github.com/nuxt/nuxt.js/projects/1
Donate
Feel free to make a donation to support us.