Nuxt is an intuitive and extendable way to create type-safe, performant and production-grade full-stack web apps and websites with Vue 3.
Go to file
Daniel Roe e634a1ebd7
test: slightly improve test reliability (#27811)
2024-06-25 08:48:39 +02:00
.devcontainer chore: fix `devcontainer.json` syntax (#26776) 2024-04-15 16:17:26 +02:00
.github ci: only run scorecards against `main` branch 2024-06-24 23:45:42 +02:00
.stackblitz chore: use `dev:prepare` instead of `build:stub` 2023-12-19 12:21:15 +00:00
.vscode chore: add volar to workspace recommendations 2023-07-06 17:09:41 +01:00
docs docs: warn about awaiting `useFetch`/`AsyncData` in wrappers (#27785) 2024-06-24 11:03:47 +01:00
examples docs(examples): add bullet points 2023-06-19 19:52:16 +02:00
packages chore(deps): update all non-major dependencies (main) (#27767) 2024-06-24 20:00:43 +02:00
playground chore: disable `shamefully-hoist` within repo (#27483) 2024-06-07 21:55:12 +01:00
scripts chore: allow major bumps 2024-06-19 15:46:20 +01:00
test test: slightly improve test reliability (#27811) 2024-06-25 08:48:39 +02:00
.editorconfig chore: upgrade to monorepo 2021-03-18 15:26:41 +01:00
.gitignore chore: cleanup eslint rules with latest `@nuxt/eslint-config` (#26653) 2024-04-05 19:08:32 +01:00
.gitpod.yml chore: use `dev:prepare` instead of `build:stub` 2023-12-19 12:21:15 +00:00
.markdownlint.yml docs: update to new website (#23743) 2023-10-18 12:59:43 +02:00
.markdownlintignore chore: update markdownlintignore 2023-12-08 10:40:36 +01:00
.npmrc chore: disable `shamefully-hoist` within repo (#27483) 2024-06-07 21:55:12 +01:00
.nuxtrc chore: use `nuxt.config` to enable pages for docs typecheck 2024-02-16 20:53:40 +00:00
LICENSE chore: update licence title 2023-01-24 22:23:47 +00:00
README.md chore: use relative links and update in build script 2024-06-16 08:51:12 +01:00
SECURITY.md chore: remove huntr + encourage GitHub vulnerability reporting (#23754) 2023-10-18 18:37:36 +01:00
changelog.config.json chore: update internal repo/issue links to use`nuxt/nuxt` 2023-01-19 19:37:07 +00:00
eslint.config.mjs chore(deps): update all non-major dependencies (main) (#27767) 2024-06-24 20:00:43 +02:00
knip.json chore: update knip schema 2024-03-16 14:58:52 -07:00
lychee.toml chore: ignore SSL certificate error with `conventionalcommits.org` 2024-04-19 17:33:09 +03:00
nuxt.config.ts chore: cleanup eslint rules with latest `@nuxt/eslint-config` (#26653) 2024-04-05 19:08:32 +01:00
package.json chore(deps): update all non-major dependencies (main) (#27767) 2024-06-24 20:00:43 +02:00
pnpm-lock.yaml chore(deps): update all non-major dependencies (main) (#27767) 2024-06-24 20:00:43 +02:00
pnpm-workspace.yaml docs: update to new website (#23743) 2023-10-18 12:59:43 +02:00
renovate.json chore(deps): update all non-major dependencies (main) (#27767) 2024-06-24 20:00:43 +02:00
tea.yaml chore: rename to yaml 2024-03-19 19:54:04 +00:00
tsconfig.json chore(deps): update all non-major dependencies (main) (#27767) 2024-06-24 20:00:43 +02:00
vitest.config.ts chore: cleanup eslint rules with latest `@nuxt/eslint-config` (#26653) 2024-04-05 19:08:32 +01:00
vitest.nuxt.config.ts chore(deps): update devdependency @nuxt/test-utils to v3.13.0 (main) (#27238) 2024-05-20 01:02:54 -05:00

README.md

Nuxt banner

Nuxt

Version Downloads License Website Discord

Nuxt is a free and open-source framework with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with Vue.js.

It provides a number of features that make it easy to build fast, SEO-friendly, and scalable web applications, including:

  • Server-side rendering, Static Site Generation, Hybrid Rendering and Edge-Side Rendering
  • Automatic routing with code-splitting and pre-fetching
  • Data fetching and state management
  • SEO Optimization and Meta tags definition
  • Auto imports of components, composables and utils
  • TypeScript with zero configuration
  • Go fullstack with our server/ directory
  • Extensible with 200+ modules
  • Deployment to a variety of hosting platforms
  • ...and much more 🚀

Table of Contents


🚀 Getting Started

Use the following command to create a new starter project. This will create a starter project with all the necessary files and dependencies:

npx nuxi@latest init <my-project>

[!TIP] Discover also nuxt.new: Open a Nuxt starter on CodeSandbox, StackBlitz or locally to get up and running in a few seconds.

💻 Vue Development

Simple, intuitive and powerful, Nuxt lets you write Vue components in a way that makes sense. Every repetitive task is automated, so you can focus on writing your full-stack Vue application with confidence.

Example of an app.vue:

<script setup lang="ts">
useSeoMeta({
  title: 'Meet Nuxt',
  description: 'The Intuitive Vue Framework.'
})
</script>

<template>
  <div id="app">
    <AppHeader />
    <NuxtPage />
    <AppFooter />
  </div>
</template>

<style scoped>
#app {
  background-color: #020420;
  color: #00DC82;
}
</style>

📖 Documentation

We highly recommend you take a look at the Nuxt documentation to level up. Its a great resource for learning more about the framework. It covers everything from getting started to advanced topics.

🧩 Modules

Discover our list of modules to supercharge your Nuxt project, created by the Nuxt team and community.

❤️ Contribute

We invite you to contribute and help improve Nuxt 💚

Here are a few ways you can get involved:

  • Reporting Bugs: If you come across any bugs or issues, please check out the reporting bugs guide to learn how to submit a bug report.
  • Suggestions: Have ideas to enhance Nuxt? We'd love to hear them! Check out the contribution guide to share your suggestions.
  • Questions: If you have questions or need assistance, the getting help guide provides resources to help you out.

🏠 Local Development

Follow the docs to Set Up Your Local Development Environment to contribute to the framework and documentation.

⛰️ Nuxt 2

You can find the code for Nuxt 2 on the 2.x branch and the documentation at v2.nuxt.com.

If you expect to be using Nuxt 2 beyond the EOL (End of Life) date (June 30, 2024), and still need a maintained version that can satisfy security and browser compatibility requirements, make sure to check out HeroDevs NES (Never-Ending Support) Nuxt 2.

🛟 Professional Support

🔗 Follow us

Discord  Twitter  GitHub

⚖️ License

MIT