mirror of https://github.com/nuxt/nuxt.git synced 2024-11-22 21:55:11 +00:00

Nuxt is an intuitive and extendable way to create type-safe, performant and production-grade full-stack web apps and websites with Vue 3.

csr full-stack hybrid node nuxt server-rendering ssg ssr static-site-generator universal vue

Go to file

Daniel Roe f7b13427cf chore: lint		2023-09-05 12:02:12 +01:00
.github	chore(deps): update all non-major dependencies	2023-09-05 10:31:58 +00:00
.stackblitz	feat(nuxt): migrate to new `nuxt/cli` (#22799 )	2023-08-25 16:20:32 +01:00
.vscode	chore: add volar to workspace recommendations	2023-07-06 17:09:41 +01:00
.website	chore(deps): pin devdependency @nuxt-themes/docus to 1.14.6 (main) (#22473 )	2023-08-04 08:07:38 +01:00
docs	docs: add information about server component context (#22964 )	2023-09-05 11:29:28 +01:00
examples	docs(examples): add bullet points	2023-06-19 19:52:16 +02:00
packages	chore: lint	2023-09-05 12:02:12 +01:00
playground	chore: add explicit vue dependency in fixtures	2023-07-06 13:07:17 +01:00
scripts	ci: use changelogen utility to get current branch	2023-09-04 09:44:28 +01:00
test	fix(nuxt): always use increment for id with client side islands (#22975 )	2023-09-05 11:27:00 +01:00
.editorconfig	chore: upgrade to monorepo	2021-03-18 15:26:41 +01:00
.eslintrc	chore: replace `.eslintignore` file with 'ignorePatterns' (#22547 )	2023-08-08 22:32:13 +01:00
.gitignore	feat(nuxt): migrate to new `nuxt/cli` (#22799 )	2023-08-25 16:20:32 +01:00
.gitpod.yml	chore: use pnpm for framework monorepo (#7895 )	2022-10-17 12:10:05 +02:00
.markdownlint.yml	docs: re-enable docs linting and update docs (#20084 )	2023-04-04 06:23:13 -07:00
.markdownlintignore	docs: re-enable docs linting and update docs (#20084 )	2023-04-04 06:23:13 -07:00
.npmrc	chore: use pnpm for framework monorepo (#7895 )	2022-10-17 12:10:05 +02:00
.nuxtrc	ci: run webpack/vite and dev/prod as matrices (#18905 )	2023-02-13 22:09:32 +00:00
changelog.config.json	chore: update internal repo/issue links to use`nuxt/nuxt`	2023-01-19 19:37:07 +00:00
knip.json	chore: prune internal unused code and exports (#21809 )	2023-06-27 10:38:40 +01:00
LICENSE	chore: update licence title	2023-01-24 22:23:47 +00:00
package.json	chore: use workspace protocol without path	2023-09-05 11:50:54 +01:00
pnpm-lock.yaml	chore: dedupe lockfile	2023-09-05 11:38:22 +01:00
pnpm-workspace.yaml	docs: add temporary website for docs contribution (#22469 )	2023-08-03 14:44:10 +01:00
README.md	docs: simplify readme	2023-08-30 11:06:45 +02:00
renovate.json	chore(deps): bump typescript/untyped versions (#22340 )	2023-07-30 10:16:13 +01:00
SECURITY.md	chore: update internal repo/issue links to use`nuxt/nuxt`	2023-01-19 19:37:07 +00:00
tsconfig.json	test: add `nuxt-vitest` and composable unit tests (#21884 )	2023-07-02 09:59:16 +01:00
vitest.config.ts	feat(nuxt): experimental native async context support (#20918 )	2023-08-08 00:57:35 +02:00
vitest.nuxt.config.ts	fix(vite): include `import.meta` build vars in `define` as well (#22576 )	2023-08-10 09:51:58 +01:00

README.md

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 or Hybrid Rendering
Automatic routing with code-splitting
State management
SEO Optimization
Extandable with 100+ modules
Deployment to a variety of hosting platforms
...and much more 🚀

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 nuxi init <my-project>

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

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.