UNPKG

13.3 kBMarkdownView Raw
1<p align="center"><img align="center" style="width:320px" src="https://nuxtjs.org/meta_400.png"/></p><br/>
2<p align="center">
3 <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>
4 <a href="https://dev.azure.com/nuxt/nuxt.js/_build/latest?definitionId=1"><img src="https://dev.azure.com/nuxt/nuxt.js/_apis/build/status/nuxt.js" alt="Azure Build Status"></a>
5  <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>
6 <a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/dm/nuxt" alt="Downloads"></a>
7 <a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/v/nuxt" alt="Version"></a>
8 <a href="https://www.npmjs.com/package/nuxt"><img src="https://badgen.net/npm/license/nuxt" alt="License"></a>
9 <a href="https://discord.nuxtjs.org/"><img src="https://badgen.net/badge/Discord/join-us/7289DA" alt="Discord"></a>
10 </p>
11 <p align="center">
12 <a href="#platinum-sponsors" alt="Platinum Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/platinum-sponsors/badge.svg" /></a>
13 <a href="#gold-sponsors" alt="Gold Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/gold-sponsors/badge.svg" /></a>
14 <a href="#silver-sponsors" alt="Silver Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/silver-sponsors/badge.svg" /></a>
15 <a href="#bronze-sponsors" alt="Bronze Sponsors on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/bronze-sponsors/badge.svg" /></a>
16 <a href="#nuxters" alt="Nuxters on Open Collective"><img src="https://opencollective.com/nuxtjs/tiers/nuxters/badge.svg" /></a>
17 <a href="https://oc.nuxtjs.org/"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
18</p>
19<p align="center">
20 <a href="https://otechie.com/nuxt?ref=badge"><img src="https://api.otechie.com/consultancy/nuxt/badge.svg" alt="Hire Nuxt"></a>
21</p>
22
23> Build your next Vue.js application with confidence using Nuxt.js: a framework making web development simple and powerful.
24
25## Links
26
27- 📘 Documentation: [https://nuxtjs.org](https://nuxtjs.org)
28- 👥 Community: [cmty.app/nuxt](https://cmty.app/nuxt)
29- 🎬 Video: [1 minute demo](https://www.youtube.com/watch?v=kmf-p-pTi40)
30- 🐦 Twitter: [@nuxt_js](https://twitter.nuxtjs.org/)
31- 💬 Chat: [Discord](https://discord.nuxtjs.org/)
32- 🌟 [AwesomeNuxt](https://awesome.nuxtjs.org/)
33- 👉 [Play with Nuxt.js online](https://template.nuxtjs.org)
34
35## Features
36
37- Automatic transpilation and bundling (with webpack and babel)
38- Hot code reloading
39- Server-side rendering OR Single Page App OR Static Generated, you choose :fire:
40- Static file serving. `./static/` is mapped to `/`
41- Configurable with a `nuxt.config.js` file
42- Custom layouts with the `layouts/` directory
43- Middleware
44- Code splitting for every `pages/`
45- Loading just the critical CSS (page-level)
46
47Learn more at <https://nuxtjs.org>.
48
49## Getting started
50
51```sh
52$ npx create-nuxt-app <project-name>
53```
54
55It's as simple as that!
56
57Learn more at https://nuxtjs.org/guide/installation
58
59## Examples
60
61Please take a look at <https://nuxtjs.org/examples> or directly in <https://github.com/nuxt/nuxt.js/tree/dev/examples>.
62
63## Production deployment
64
65To deploy, instead of running nuxt, you probably want to build ahead of time. Therefore, building and starting are separate commands:
66
67```bash
68nuxt build
69nuxt start
70```
71
72Learn more at https://nuxtjs.org/guide/commands#production-deployment
73
74## Consulting from the Nuxt team
75
76Get 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)
77
78## Professional support with TideLift
79
80Professionally supported Nuxt.js is now available!
81
82Tidelift 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.
83
84[Get supported Nuxt with the Tidelift Subscription](https://tidelift.com/subscription/pkg/npm-nuxt?utm_source=npm-nuxt&utm_medium=readme).
85
86## Supporting Nuxt.js
87
88Nuxt.js is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers.
89Funds 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.
90
91Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/nuxtjs#contribute)]
92
93### Platinum Sponsors
94
95[![Open Collective Platinum Sponsors][platinum-sponsors-src]][platinum-sponsors-href]
96
97### Gold Sponsors
98
99[![Open Collective Gold Sponsors][gold-sponsors-src]][gold-sponsors-href]
100
101### Silver Sponsors
102
103[![Open Collective Silver Sponsors][silver-sponsors-src]][silver-sponsors-href]
104
105### Bronze Sponsors
106
107[![Open Collective Bronze Sponsors][bronze-sponsors-src]][bronze-sponsors-href]
108
109### Nuxters
110
111[![Open Collective Nuxters][nuxters-src]][nuxters-href]
112
113## Core team
114
115<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
116<!-- prettier-ignore -->
117<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.js/issues?q=author%3AAtinux" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt.js/commits?author=Atinux" title="Code">💻</a> <a href="#design-Atinux" title="Design">🎨</a> <a href="https://github.com/Atinux/Nuxt.js/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.js/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.js/issues?q=author%3Api0" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt.js/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.js/issues?q=author%3Aclarkdo" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt.js/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.js/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.js/issues?q=author%3AmanniL" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt.js/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.js/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.js/issues?q=author%3Agalvez" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt.js/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.js/commits?author=galvez" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/aldarund"><img src="https://avatars2.githubusercontent.com/u/571159?v=4" width="120px;" alt="Dmitry Molotkov"/><br /><sub><b>Dmitry Molotkov</b></sub></a><br /><a href="#question-aldarund" title="Answering Questions">💬</a> <a href="https://github.com/Atinux/Nuxt.js/issues?q=author%3Aaldarund" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt.js/commits?author=aldarund" title="Code">💻</a> <a href="#ideas-aldarund" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-aldarund" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://github.com/kevinmarrec"><img src="https://avatars2.githubusercontent.com/u/25272043?v=4" width="120px;" alt="Kevin Marrec"/><br /><sub><b>Kevin Marrec</b></sub></a><br /><a href="https://github.com/Atinux/Nuxt.js/commits?author=kevinmarrec" title="Code">💻</a> <a href="#ideas-kevinmarrec" title="Ideas, Planning, & Feedback">🤔</a> <a href="#platform-kevinmarrec" title="Packaging/porting to new platform">📦</a> <a href="#review-kevinmarrec" title="Reviewed Pull Requests">👀</a></td></tr><tr><td align="center"><a href="https://github.com/pimlie"><img src="https://avatars3.githubusercontent.com/u/1067403?v=4" width="120px;" alt="Pim"/><br /><sub><b>Pim</b></sub></a><br /><a href="https://github.com/Atinux/Nuxt.js/issues?q=author%3Apimlie" title="Bug reports">🐛</a> <a href="https://github.com/Atinux/Nuxt.js/commits?author=pimlie" title="Code">💻</a></td></tr></table>
118
119<!-- ALL-CONTRIBUTORS-LIST:END -->
120
121## Contributors
122
123Thank you to all our [contributors](https://github.com/nuxt/nuxt.js/graphs/contributors)!
124
125[![Nuxt.js Contributors][contributors-src]][contributors-href]
126
127## Contributing
128
129[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/nuxt/nuxt.js)
130
131Please refer to our [Contribution Guide](https://nuxtjs.org/guide/contribution-guide#codefund_ad)
132
133## Cross-browser testing
134
135Thanks to [BrowserStack](http://browserstack.com)!
136
137<a href="http://browserstack.com"><img height="70" src="https://nuxtjs.org/browserstack.svg" alt="BrowserStack"></a>
138
139## Automated testing
140
141Thanks to [SauceLabs](https://saucelabs.com) for supporting Open Source <3
142
143<a href="https://saucelabs.com"><img height="70" src="https://nuxtjs.org/saucelabs.svg" alt="SauceLabs"></a>
144
145## Security
146
147If 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.
148
149## License
150
151[MIT](https://github.com/nuxt/nuxt.js/blob/dev/LICENSE)
152
153<!-- Open Collective Tiers -->
154[platinum-sponsors-src]: https://opencollective.com/nuxtjs/tiers/platinum-sponsors.svg?avatarHeight=96&width=890
155[platinum-sponsors-href]: https://opencollective.com/nuxtjs#contributors
156[gold-sponsors-src]: https://opencollective.com/nuxtjs/tiers/gold-sponsors.svg?avatarHeight=80&width=890
157[gold-sponsors-href]: https://opencollective.com/nuxtjs#contributors
158[silver-sponsors-src]: https://opencollective.com/nuxtjs/tiers/silver-sponsors.svg?avatarHeight=64&width=890
159[silver-sponsors-href]: https://opencollective.com/nuxtjs#contributors
160[bronze-sponsors-src]: https://opencollective.com/nuxtjs/tiers/bronze-sponsors.svg?avatarHeight=48&width=890
161[bronze-sponsors-href]: https://opencollective.com/nuxtjs#contributors
162[nuxters-src]: https://opencollective.com/nuxtjs/tiers/nuxters.svg?width=890&button=false
163[nuxters-href]: https://opencollective.com/nuxtjs#contributors
164[contributors-src]: https://opencollective.com/nuxtjs/contributors.svg?width=890&button=false
165[contributors-href]: https://github.com/nuxt/nuxt.js/graphs/contributors