Back to Nuxt

Nuxt

README.md

4.4.45.7 KB
Original Source

<a href="https://nuxt.com"></a>

Nuxt

<p> <a href="https://npmx.dev/package/nuxt"></a> <a href="https://npmx.dev/package/nuxt"></a> <a href="https://github.com/nuxt/nuxt/blob/main/LICENSE"></a> <a href="https://nuxt.com/modules"></a> <a href="https://nuxt.com"></a> <a href="https://chat.nuxt.dev"></a> <a href="https://securityscorecards.dev/viewer/?uri=github.com/nuxt/nuxt"></a> <a href="https://deepwiki.com/nuxt/nuxt"></a> </p>

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
  • Search engine optimization and defining meta tags
  • Auto imports of components, composables and utils
  • TypeScript with zero configuration
  • Go full-stack with our server/ directory
  • Extensible with 300+ modules
  • Deployment to a variety of hosting platforms
  • ...and much more πŸš€

Table of Contents


<a name="getting-started">πŸš€ Getting Started</a>

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

bash
npm create nuxt@latest <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.

<a name="vue-development">πŸ’» Vue Development</a>

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:

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>

<a name="documentation">πŸ“– Documentation</a>

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

<a name="modules">🧩 Modules</a>

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

<a name="contribute">❀️ Contribute</a>

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.

<a name="local-development">🏠 Local Development</a>

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

<a name="professional-support">πŸ›Ÿ Professional Support</a>

<a name="follow-us">πŸ”— Follow Us</a>

<p valign="center"> <a href="https://go.nuxt.com/discord"></a>&nbsp;&nbsp;<a href="https://go.nuxt.com/x"></a>&nbsp;&nbsp;<a href="https://go.nuxt.com/github"></a>&nbsp;&nbsp;<a href="https://go.nuxt.com/bluesky"></a> </p>

<a name="license">βš–οΈ License</a>

MIT