Nuxt/README.md

284 lines
19 KiB
Markdown
Raw Normal View History

2016-11-29 13:14:32 +00:00
<p align="center"><img align="center" src="http://imgur.com/V4LtoII.png"/></p>
2016-11-23 13:05:22 +00:00
<p align="center">
2018-02-07 01:10:55 +00:00
<a href="https://circleci.com/gh/nuxt/nuxt.js"><img src="https://img.shields.io/circleci/project/github/nuxt/nuxt.js.svg" alt="Build Status"></a>
2016-12-21 20:01:06 +00:00
<a href="https://travis-ci.org/nuxt/nuxt.js"><img src="https://img.shields.io/travis/nuxt/nuxt.js/master.svg" alt="Build Status"></a>
2018-03-01 15:49:16 +00:00
<a href="https://ci.appveyor.com/project/nuxt/nuxt-js"><img src="https://ci.appveyor.com/api/projects/status/9ttoamt2c2gnwkko?svg=true" alt="Windows Build Status"></a>
2018-01-10 16:26:21 +00:00
 <a href="https://codecov.io/gh/nuxt/nuxt.js"><img src="https://img.shields.io/codecov/c/github/nuxt/nuxt.js/master.svg" alt="Coverage Status"></a>
2017-05-15 15:41:43 +00:00
<a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg" alt="Downloads"></a>
2016-11-23 13:05:22 +00:00
<a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg" alt="Version"></a>
<a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/l/nuxt.svg" alt="License"></a>
2016-12-23 16:50:04 +00:00
<a href="https://gitter.im/nuxt/nuxt.js"><img src="https://img.shields.io/badge/GITTER-join%20chat-green.svg" alt="Gitter"></a>
2017-05-11 11:56:57 +00:00
</p>
<p align="center">
<a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/backerss/badge.svg" /></a>
<a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/sponsorss/badge.svg" /></a>
2017-05-11 11:56:57 +00:00
<a href="https://opencollective.com/nuxtjs"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
2017-05-17 08:33:39 +00:00
2016-11-23 13:05:22 +00:00
</p>
2017-03-20 15:29:51 +00:00
> Vue.js Meta Framework to create complex, fast & universal web applications *quickly*.
2016-10-26 11:40:55 +00:00
2018-01-05 09:29:24 +00:00
## Links
- 📘 Documentation: [https://nuxtjs.org](https://nuxtjs.org)
2018-03-31 10:51:45 +00:00
- 👥 [Community](https://nuxtjs.cmty.io)
2018-01-05 09:29:24 +00:00
- 🎬 Video: [1 minute demo](https://www.youtube.com/watch?v=kmf-p-pTi40)
- 🐦 Twitter: [@nuxt_js](https://twitter.com/nuxt_js)
- 📦 [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).
2016-11-15 13:26:11 +00:00
## Partners
2018-05-05 21:44:19 +00:00
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>
2018-05-05 22:02:51 +00:00
<a href="https://opencollective.com/nuxtjs/tiers/partner/0/website" target="_blank" rel="noopener noreferrer"><img height="72px" src="https://user-images.githubusercontent.com/1016365/34124854-48fafa06-e3e9-11e7-8c04-251055feebee.png">
2018-05-05 21:49:22 +00:00
</a>
</p>
2017-05-17 08:33:39 +00:00
## 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>
2017-05-17 08:33:39 +00:00
</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>
2017-05-17 08:33:39 +00:00
</p>
2016-12-25 18:15:50 +00:00
## Getting started
2016-10-26 11:40:55 +00:00
```
2018-03-30 02:10:16 +00:00
$ npm install nuxt
2016-10-26 11:40:55 +00:00
```
Add a script to your package.json like this:
2016-10-26 11:40:55 +00:00
```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.
2016-10-26 11:40:55 +00:00
Populate `./pages/index.vue` inside your project:
```html
<template>
<h1>Hello {{ name }}!</h1>
</template>
<script>
export default {
data: () => {
return { name: 'world' }
}
2016-10-26 11:40:55 +00:00
}
</script>
```
And then run:
```bash
npm start
```
Go to [http://localhost:3000](http://localhost:3000)
2016-10-26 11:40:55 +00:00
2017-01-31 15:40:50 +00:00
## Templates
2018-01-31 11:33:11 +00:00
: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.
2018-01-05 09:29:24 +00:00
Or you can start by using one of our starter templates:
2017-07-27 15:10:20 +00:00
- [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
2017-07-27 15:13:05 +00:00
- [micro](https://github.com/nuxt-community/micro-template): Nuxt.js + Micro
2017-10-16 15:01:19 +00:00
- [nuxtent](https://github.com/nuxt-community/nuxtent-template): Nuxt.js + Nuxtent module for content heavy sites
2017-01-31 15:40:50 +00:00
## Using nuxt.js programmatically
```js
2017-07-30 17:09:16 +00:00
const { Nuxt, Builder } = require('nuxt')
2017-07-30 17:09:16 +00:00
// Import and set nuxt.js options
2016-12-25 18:08:30 +00:00
let config = require('./nuxt.config.js')
2018-01-05 10:38:29 +00:00
config.dev = (process.env.NODE_ENV !== 'production')
2017-07-30 17:09:16 +00:00
2016-12-25 18:08:30 +00:00
let nuxt = new Nuxt(config)
2017-07-30 17:09:16 +00:00
// 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)
```
2017-01-31 15:40:50 +00:00
Learn more: https://nuxtjs.org/api/nuxt
2016-10-26 11:40:55 +00:00
## Using nuxt.js as a middleware
2018-03-02 23:35:07 +00:00
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)
```
2017-01-31 15:40:50 +00:00
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)
2016-11-10 01:19:47 +00:00
.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:
2016-11-10 01:19:47 +00:00
if (error) {
return res.status(error.statusCode || 500).send(html)
}
res.send(html)
})
.catch(function (error) {
// And error appended while rendering the route
})
```
2017-01-31 15:40:50 +00:00
Learn more: https://nuxtjs.org/api/nuxt-render-route
## Examples
2018-01-05 10:38:29 +00:00
Please take a look at https://nuxtjs.org/examples or directly in https://github.com/nuxt/nuxt.js/tree/dev/examples.
## Production deployment
2016-11-10 13:30:18 +00:00
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": {
2016-11-10 13:30:18 +00:00
"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`.
2017-01-15 15:36:28 +00:00
2018-01-05 10:38:29 +00:00
## 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) |
| --- | --- | --- | --- |
| [![Atinux](https://avatars1.githubusercontent.com/u/904724?s=150&v=4)](https://github.com/Atinux) | [![alexchopin](https://avatars1.githubusercontent.com/u/4084277?s=150&v=4)](https://github.com/alexchopin) | [![pi0](https://avatars1.githubusercontent.com/u/5158436?s=150&v=4)](https://github.com/pi0) | [![clarkdo](https://avatars3.githubusercontent.com/u/4312154?s=150&v=4)](https://github.com/clarkdo) |
2018-01-05 10:40:08 +00:00
## Contributors
2017-01-15 15:36:28 +00:00
2018-01-05 10:40:08 +00:00
Thank you to all our [contributors](https://github.com/nuxt/nuxt.js/graphs/contributors)!
2017-10-16 15:01:19 +00:00
## Contributing
2018-01-05 10:40:08 +00:00
2017-10-21 16:32:44 +00:00
Please see our [CONTRIBUTING.md](./CONTRIBUTING.md)
2018-01-05 10:40:08 +00:00
## Roadmap
https://trello.com/b/lgy93IOl/nuxtjs-10
2018-05-07 15:10:57 +00:00
## License
[MIT](https://github.com/nuxt/nuxt.js/blob/dev/LICENSE.md)