Nuxt/distributions/nuxt/README.md

166 lines
13 KiB
Markdown
Raw Normal View History

2019-02-06 15:34:20 +00:00
<p align="center"><img align="center" style="width:320px" src="https://nuxtjs.org/meta_400.png"/></p><br/>
2018-11-16 14:30:11 +00:00
<p align="center">
2020-03-17 16:42:33 +00:00
<a href="https://github.com/nuxt/nuxt.js/actions?query=branch%3Adev+event%3Apush"><img src="https://github.com/nuxt/nuxt.js/workflows/test/badge.svg?branch=dev&event=push" alt="Tests Status"></a>
2020-08-27 10:26:59 +00:00
<a href="https://github.com/nuxt/nuxt.js/actions?query=branch%3Adev+event%3Apush"><img src="https://github.com/nuxt/nuxt.js/workflows/windows/badge.svg?branch=dev&event=push" alt="Windows Status"></a>
2019-12-17 10:22:18 +00:00
 <a href="https://codecov.io/gh/nuxt/nuxt.js"><img src="https://badgen.net/codecov/c/github/nuxt/nuxt.js/master" alt="Coverage Status"></a>
2018-11-16 14:30:11 +00:00
<a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/dm/nuxt" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/v/nuxt" alt="Version"></a>
<a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/license/nuxt" alt="License"></a>
<a href="https://discord.nuxtjs.org/"><img src="https://badgen.net/badge/Discord/join-us/7289DA" alt="Discord"></a>
</p>
<p align="center">
2019-12-17 10:22:18 +00:00
<a href="#platinum-sponsors" alt="Platinum Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/platinum-sponsors/badge.svg" /></a>
2019-07-09 18:25:32 +00:00
<a href="#gold-sponsors" alt="Gold Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/gold-sponsors/badge.svg" /></a>
<a href="#silver-sponsors" alt="Silver Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/silver-sponsors/badge.svg" /></a>
<a href="#bronze-sponsors" alt="Bronze Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/bronze-sponsors/badge.svg" /></a>
<a href="#nuxters" alt="Nuxters on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/nuxters/badge.svg" /></a>
2018-11-16 14:30:11 +00:00
<a href="https://oc.nuxtjs.org/"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
2019-02-06 15:34:20 +00:00
</p>
<p align="center">
<a href="https://otechie.com/nuxt?ref=badge"><img src="https://api.otechie.com/consultancy/nuxt/badge.svg" alt="Hire Nuxt"></a>
2018-11-16 14:30:11 +00:00
</p>
2020-11-30 22:44:04 +00:00
> Build your next Vue.js application with confidence using Nuxt: a framework making web development simple and powerful.
2018-11-16 14:30:11 +00:00
## 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/)
2019-03-06 14:03:43 +00:00
- 🌟 [AwesomeNuxt](https://awesome.nuxtjs.org/)
2020-11-30 22:44:04 +00:00
- 👉 [Play with Nuxt online](https://template.nuxtjs.org)
2018-11-16 14:30:11 +00:00
## 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)
2018-11-16 14:30:11 +00:00
2019-05-30 17:08:36 +00:00
Learn more at <https://nuxtjs.org>.
2018-11-16 14:30:11 +00:00
2020-03-25 19:20:29 +00:00
## Getting started
```sh
$ npx create-nuxt-app <project-name>
```
It's as simple as that!
Learn more at https://nuxtjs.org/guide/installation
## 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:
```bash
nuxt build
nuxt start
```
Learn more at https://nuxtjs.org/guide/commands#production-deployment
2019-02-06 15:34:20 +00:00
## Consulting from the Nuxt team
2019-03-06 14:03:43 +00:00
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)
2019-02-06 15:34:20 +00:00
2018-11-16 14:30:11 +00:00
## Professional support with TideLift
2020-11-30 22:44:04 +00:00
Professionally supported Nuxt is now available!
2018-11-16 14:30:11 +00:00
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).
2020-11-30 22:44:04 +00:00
## Supporting Nuxt
2018-11-16 14:30:11 +00:00
2020-11-30 22:44:04 +00:00
Nuxt is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers.
2019-07-09 18:25:32 +00:00
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.
2018-11-16 14:30:11 +00:00
2019-07-09 18:25:32 +00:00
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/nuxtjs#contribute)]
2018-11-16 14:30:11 +00:00
2019-12-17 10:22:18 +00:00
### Platinum Sponsors
2018-11-16 14:30:11 +00:00
2019-12-17 10:22:18 +00:00
[![Open Collective Platinum Sponsors][platinum-sponsors-src]][platinum-sponsors-href]
2018-11-16 14:30:11 +00:00
2019-07-09 18:25:32 +00:00
### Gold Sponsors
2018-11-16 14:30:11 +00:00
2019-07-09 18:25:32 +00:00
[![Open Collective Gold Sponsors][gold-sponsors-src]][gold-sponsors-href]
2018-11-16 14:30:11 +00:00
2019-07-09 18:25:32 +00:00
### Silver Sponsors
2018-11-16 14:30:11 +00:00
2019-07-09 18:25:32 +00:00
[![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]
2018-11-16 14:30:11 +00:00
## Core team
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
2020-11-30 22:44:04 +00:00
<table><tr><td align="center"><a href="https://github.com/atinux"><img src="https://avatars2.githubusercontent.com/u/904724?v=4" width="120px;" alt="Sébastien Chopin"/><br /><sub><b>Sébastien Chopin</b></sub></a><br /><a href="#blog-Atinux" title="Blogposts">📝</a> <a href="https://github.com/Atinux/Nuxt/issues?q=author%3AAtinux" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt/commits?author=Atinux" title="Code">💻</a> <a href="#design-Atinux" title="Design">🎨</a> <a href="https://github.com/Atinux/Nuxt/commits?author=Atinux" title="Documentation">📖</a> <a href="#question-Atinux" title="Answering Questions">💬</a> <a href="#review-Atinux" title="Reviewed Pull Requests">👀</a> <a href="#talk-Atinux" title="Talks">📢</a></td><td align="center"><a href="https://github.com/alexchopin"><img src="https://avatars2.githubusercontent.com/u/4084277?v=4" width="120px;" alt="Alexandre Chopin"/><br /><sub><b>Alexandre Chopin</b></sub></a><br /><a href="#design-alexchopin" title="Design">🎨</a> <a href="https://github.com/Atinux/Nuxt/commits?author=alexchopin" title="Documentation">📖</a> <a href="#eventOrganizing-alexchopin" title="Event Organizing">📋</a> <a href="#platform-alexchopin" title="Packaging/porting to new platform">📦</a> <a href="#question-alexchopin" title="Answering Questions">💬</a> <a href="#talk-alexchopin" title="Talks">📢</a></td><td align="center"><a href="https://github.com/pi0"><img src="https://avatars0.githubusercontent.com/u/5158436?v=4" width="120px;" alt="Pooya Parsa"/><br /><sub><b>Pooya Parsa</b></sub></a><br /><a href="https://github.com/Atinux/Nuxt/issues?q=author%3Api0" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt/commits?author=pi0" title="Code">💻</a> <a href="#plugin-pi0" title="Plugin/utility libraries">🔌</a> <a href="#question-pi0" title="Answering Questions">💬</a> <a href="#review-pi0" title="Reviewed Pull Requests">👀</a> <a href="#tool-pi0" title="Tools">🔧</a></td><td align="center"><a href="https://github.com/clarkdo"><img src="https://avatars3.githubusercontent.com/u/4312154?v=4" width="120px;" alt="Clark Du"/><br /><sub><b>Clark Du</b></sub></a><br /><a href="https://github.com/Atinux/Nuxt/issues?q=author%3Aclarkdo" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt/commits?author=clarkdo" title="Code">💻</a> <a href="#example-clarkdo" title="Examples">💡</a> <a href="#review-clarkdo" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/Atinux/Nuxt/commits?author=clarkdo" title="Tests">⚠️</a> <a href="#tool-clarkdo" title="Tools">🔧</a></td></tr><tr><td align="center"><a href="https://github.com/manniL"><img src="https://avatars0.githubusercontent.com/u/640208?s=460&v=4" width="120px;" alt="Alexander Lichter"/><br /><sub><b>Alexander Lichter</b></sub></a><br /><a href="#question-manniL" title="Answering Questions">💬</a> <a href="https://github.com/Atinux/Nuxt/issues?q=author%3AmanniL" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt/commits?author=manniL" title="Code">💻</a> <a href="#example-manniL" title="Examples">💡</a> <a href="#review-manniL" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/Atinux/Nuxt/commits?author=manniL" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/galvez"><img src="https://avatars1.githubusercontent.com/u/12291?s=460&v=4" width="120px;" alt="Jonas Galvez"/><br /><sub><b>Jonas Galvez</b></sub></a><br /><a href="#question-galvez" title="Answering Questions">💬</a> <a href="https://github.com/Atinux/Nuxt/issues?q=author%3Agalvez" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt/commits?author=galvez" title="Code">💻</a> <a href="#example-galvez" title="Examples">💡</a> <a href="#review-galvez" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/Atinux/Nuxt/commits?author=galvez" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/aldarund"><img src="https://avatars2.githubusercontent.com/u/57115
2019-04-25 08:43:50 +00:00
2018-11-16 14:30:11 +00:00
<!-- ALL-CONTRIBUTORS-LIST:END -->
## Contributors
Thank you to all our [contributors](https://github.com/nuxt/nuxt.js/graphs/contributors)!
2020-11-30 22:44:04 +00:00
[![Nuxt Contributors][contributors-src]][contributors-href]
2018-11-16 14:30:11 +00:00
## Contributing
2020-03-25 19:20:29 +00:00
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/nuxt/nuxt.js)
2018-11-16 14:30:11 +00:00
Please refer to our [Contribution Guide](https://nuxtjs.org/guide/contribution-guide#codefund_ad)
## Cross-browser testing
2019-12-17 10:22:18 +00:00
Thanks to [BrowserStack](http://browserstack.com)!
2018-11-16 14:30:11 +00:00
2019-03-06 14:03:43 +00:00
<a href="http://browserstack.com"><img height="70" src="https://nuxtjs.org/browserstack.svg" alt="BrowserStack"></a>
2018-11-16 14:30:11 +00:00
2019-12-17 10:22:18 +00:00
## Automated testing
Thanks to [SauceLabs](https://saucelabs.com) for supporting Open Source <3
<a href="https://saucelabs.com"><img height="70" src="https://nuxtjs.org/saucelabs.svg" alt="SauceLabs"></a>
2018-12-29 20:33:28 +00:00
## Security
2020-11-30 22:44:04 +00:00
If you discover a security vulnerability regarding Nuxt, please send an e-mail to the team via security@nuxtjs.org! All security vulnerabilities will be promptly addressed.
2018-12-29 20:33:28 +00:00
2018-11-16 14:30:11 +00:00
## License
[MIT](https://github.com/nuxt/nuxt.js/blob/dev/LICENSE)
2019-05-30 17:08:36 +00:00
<!-- Open Collective Tiers -->
2019-12-17 10:22:18 +00:00
[platinum-sponsors-src]: https://opencollective.com/nuxtjs/tiers/platinum-sponsors.svg?avatarHeight=96&width=890
[platinum-sponsors-href]: https://opencollective.com/nuxtjs#contributors
2019-07-09 18:25:32 +00:00
[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
2019-05-30 17:08:36 +00:00
[contributors-src]: https://opencollective.com/nuxtjs/contributors.svg?width=890&button=false
[contributors-href]: https://github.com/nuxt/nuxt.js/graphs/contributors