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
renovate[bot] 03058b5132
chore(deps): update rhysd/actionlint:1.7.1 docker digest to 435ecdb (main) (#28948)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-09-11 17:21:06 +01:00
.devcontainer chore: refresh lockfile, use `htmlnano` + pin workflow deps (#28946) 2024-09-11 15:54:22 +01:00
.github chore(deps): update rhysd/actionlint:1.7.1 docker digest to 435ecdb (main) (#28948) 2024-09-11 17:21:06 +01: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: update useFetch troubleshooting section (#28918) 2024-09-10 17:25:47 +01:00
examples docs: update `Nuxt 3` -> `Nuxt` or `Nuxt 3+` 2024-06-30 11:11:22 +01:00
packages chore: pin dep + workflow by hash 2024-09-11 16:00:53 +01:00
patches feat(kit,nuxt,schema,vite,webpack): nitropack v3 nightly (#27702) 2024-06-26 15:18:05 +02:00
playground fix(nuxt): improve accuracy of module resolution conditions (#28846) 2024-09-05 22:36:15 +02:00
scripts chore: improve accuracy of 4.x changelog (#28706) 2024-08-26 14:34:54 +01:00
test chore: refresh lockfile, use `htmlnano` + pin workflow deps (#28946) 2024-09-11 15:54:22 +01: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
CODEOWNERS chore: add @danielroe to code owners 2024-06-28 17:00:32 +01:00
LICENSE chore: update licence title 2023-01-24 22:23:47 +00:00
README.md docs: update links to social media 2024-07-31 13:18:59 +02: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 devdependency eslint-plugin-perfectionist to v3 (main) (#28264) 2024-07-23 22:07:39 +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 fix(nuxt): do not accept arbitrary strings for `MiddlewareKey` (#28676) 2024-08-26 20:57:58 +01:00
package.json chore: refresh lockfile, use `htmlnano` + pin workflow deps (#28946) 2024-09-11 15:54:22 +01:00
pnpm-lock.yaml chore: pin dep + workflow by hash 2024-09-11 16:00:53 +01:00
pnpm-workspace.yaml chore: tidying workflows + add sherif workflow (#28793) 2024-09-02 22:03:47 +01:00
renovate.json chore(deps): update vue to v3.4.36 (main) (#28415) 2024-08-08 11:04:22 +01:00
tea.yaml chore: rename to yaml 2024-03-19 19:54:04 +00:00
tsconfig.json chore: enable `noUncheckedSideEffectImports` (#28903) 2024-09-09 22:23:30 +01: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.

🛟 Professional Support

🔗 Follow Us

Discord  Twitter  GitHub

⚖️ License

MIT