2022-06-23 22:58:52 +00:00
< p align = "center" > < img alt = "Nuxt" align = "center" src = "./.github/logo.svg" / > < / 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 >
2021-09-17 13:46:56 +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" >
2022-06-23 22:58:52 +00:00
< a href = "https://github.com/sponsors/nuxt" > < img src = "https://img.shields.io/badge/Support%20us-GitHub%20Sponsors-DB61A2.svg" alt = "Support us" > < / 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 >
2018-11-16 14:30:11 +00:00
2022-06-23 22:58:52 +00:00
> Build your next Vue(2) application with confidence using Nuxt: a framework making web development simple and powerful.
## Nuxt 3
2023-03-17 15:37:14 +00:00
The evolution of Nuxt powered by Vite and Vue 3 available on:
2022-06-23 22:58:52 +00:00
- GitHub: [nuxt/framework ](https://github.com/nuxt/framework )
2023-03-17 15:37:14 +00:00
- Documentation: [nuxt.com ](https://nuxt.com/ )
2018-11-16 14:30:11 +00:00
## Links
- 📘 Documentation: [https://nuxtjs.org ](https://nuxtjs.org )
2022-06-23 22:58:52 +00:00
- 👥 Community: [GitHub discussions ](https://github.com/nuxt/nuxt.js/discussions )
2018-11-16 14:30:11 +00:00
- 🎬 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/`
2019-01-21 20:36:39 +00:00
- 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
2022-06-23 22:58:52 +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 and code reviews from the Nuxt core team: support@nuxtlabs.com
2018-11-16 14:30:11 +00:00
2023-03-17 15:37:14 +00:00
## Agency Network
When in need for more broad or long-term consulting, reach out for one of our [agency partner ](https://nuxtjs.org/partners ):
< p align = "center" >
< a href = "https://nuxtjs.org/partners/ship-shape" > < img src = "https://nuxtjs.org/img/companies/square/light/shipshape.webp" style = "margin: 1rem" height = "80px" alt = "Ship Shape" > < / a >
< a href = "https://nuxtjs.org/partners/64robots" > < img src = "https://nuxtjs.org/img/companies/square/light/64robots.svg" style = "margin: 1rem" height = "80px" alt = "64 Robots" > < / a >
< a href = "https://nuxtjs.org/partners/passionate-people" > < img src = "https://nuxtjs.org/img/companies/square/light/passionate-people.jpeg" style = "margin: 1rem" height = "80px" alt = "Passionate people" > < / a >
< a href = "https://nuxtjs.org/partners/curotec" > < img src = "https://nuxtjs.org/img/companies/square/light/curotec.jpeg" style = "margin: 1rem" height = "80px" alt = "Curotec" > < / a >
< a href = "https://nuxtjs.org/partners/mirahi" > < img src = "https://nuxtjs.org/img/companies/square/light/mirahi.svg" style = "margin: 1rem" height = "80px" alt = "Mirahi" > < / a >
< a href = "https://nuxtjs.org/partners/webreinvent" > < img src = "https://nuxtjs.org/img/companies/square/light/webreinvent.svg" style = "margin: 1rem" height = "80px" alt = "Web Reinvent" > < / a >
< a href = "https://nuxtjs.org/partners/software-things" > < img src = "https://nuxtjs.org/img/companies/square/light/software-things.svg" style = "margin: 1rem" height = "80px" alt = "Software things" > < / a >
< a href = "https://nuxtjs.org/partners/zen-architects" > < img src = "https://nuxtjs.org/img/companies/square/light/zen-architects.svg" style = "margin: 1rem" height = "80px" alt = "Zen Architects" > < / a >
< a href = "https://nuxtjs.org/partners/funkhaus" > < img src = "https://nuxtjs.org/img/companies/square/light/funkhaus.svg" style = "margin: 1rem" height = "80px" alt = "Funkhaus" > < / a >
< / p >
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
[![Open Collective Platinum Sponsors][platinum-sponsors-src]][platinum-sponsors-href]
2018-11-16 14:30:11 +00:00
## 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)
2021-09-17 13:46:56 +00:00
Please refer to our [Contribution Guide ](https://nuxtjs.org/contribution-guide/ )
2018-11-16 14:30:11 +00:00
## Cross-browser testing
2023-03-17 15:37:14 +00:00
< a href = "https://browserstack.com" >< img height = "30" align = "center" src = ".github/icons/browserstack.svg" alt = "BrowserStack" ></ a > Thanks to [BrowserStack ](http://browserstack.com )!
2018-11-16 14:30:11 +00:00
2019-12-17 10:22:18 +00:00
## Automated testing
2023-03-17 15:37:14 +00:00
< a href = "https://saucelabs.com" >< img height = "30" align = "center" src = ".github/icons/saucelabs.svg" alt = "SauceLabs" ></ a > Thanks to [SauceLabs ](https://saucelabs.com ) for supporting Open Source < 3
2019-12-17 10:22:18 +00:00
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