3a59c02cfd
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Daniel Roe <daniel@roe.dev> |
||
---|---|---|
.devcontainer | ||
.github | ||
.stackblitz | ||
.vscode | ||
docs | ||
examples | ||
packages | ||
playground | ||
scripts | ||
test | ||
.editorconfig | ||
.gitignore | ||
.gitpod.yml | ||
.markdownlint.yml | ||
.markdownlintignore | ||
.npmrc | ||
.nuxtrc | ||
changelog.config.json | ||
eslint.config.mjs | ||
knip.json | ||
LICENSE | ||
lychee.toml | ||
nuxt.config.ts | ||
package.json | ||
pnpm-lock.yaml | ||
pnpm-workspace.yaml | ||
README.md | ||
renovate.json | ||
SECURITY.md | ||
tea.yaml | ||
tsconfig.json | ||
vitest.config.ts | ||
vitest.nuxt.config.ts |
Nuxt
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
- 💻 Vue Development
- 📖 Documentation
- 🧩 Modules
- ❤️ Contribute
- 🏠 Local Development
- ⛰️ Nuxt 2
- 🛟 Professional Support
- 🔗 Follow us
- ⚖️ License
🚀 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. It’s 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
- Technical audit & consulting: Nuxt Experts
- Custom development & more: Nuxt Agencies Partners