https://github.com/nuxt/starter

Create a new Nuxt project, module, layer or start from a theme with our collection of starters.
https://github.com/nuxt/starter

nuxt nuxt-starter ssg ssr vue

Last synced: about 2 months ago
JSON representation

Create a new Nuxt project, module, layer or start from a theme with our collection of starters.

• Host: GitHub
• URL: https://github.com/nuxt/starter
• Owner: nuxt
• License: mit
• Created: 2021-05-21T08:35:12.000Z (about 3 years ago)
• Default Branch: templates
• Last Pushed: 2024-05-10T16:44:54.000Z (about 2 months ago)
• Last Synced: 2024-05-10T21:55:29.833Z (about 2 months ago)
• Topics: nuxt, nuxt-starter, ssg, ssr, vue
• Homepage: https://nuxt.new
• Size: 1.04 MB
• Stars: 403
• Watchers: 11
• Forks: 152
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome - nuxt/starter repository

README

        
# 🪄 Nuxt Starter Templates

Quickly get started with a minimal Nuxt starter template!

## Quick start

Head over to [nuxt.new](https://nuxt.new) to get started quickly.

## Usage

You can use `nuxi` CLI to clone latest template to an empty directory:

```sh-session

$ npx nuxi init [-t,--template=] []

```

**Example:** Clone `v3` to `my-app` directory:

```sh-session

$ npx nuxi init -t v3 nuxt-app

```

## Templates

Name | Description | Local     | Online |

-----|-------------|-----------|--------|

[v3](https://github.com/nuxt/starter/tree/v3) | [Nuxt 3](https://github.com/nuxt/nuxt) | `npx nuxi init nuxt-app` | [Stackblitz](https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz) / [CodeSandbox](https://codesandbox.io/p/github/nuxt/starter/v3-codesandbox) |

[module](https://github.com/nuxt/starter/tree/module) | Nuxt Module with [Module Builder](https://github.com/nuxt/module-builder) | `npx nuxi init my-module -t module` | - |

[module-devtools](https://github.com/nuxt/starter/tree/module-devtools) | Nuxt Module with [Nuxt DevTools](https://github.com/nuxt/devtools) integration | `npx nuxi init my-module -t module-devtools` | - |

[layer](https://github.com/nuxt/starter/tree/layer) | [Nuxt Layer](https://nuxt.com/docs/guide/going-further/layers) Starter with Extends (experimental) | `npx nuxi init  -t layer` | - |

[content](https://github.com/nuxt/starter/tree/content) | [Nuxt Content](https://content.nuxt.com) | `npx nuxi init content-app -t content` | [Stackblitz](https://stackblitz.com/github/nuxt/starter/tree/content) / [CodeSandbox](https://codesandbox.io/p/github/nuxt/starter/content) |

[ui](https://github.com/nuxt/starter/tree/ui) | [Nuxt UI](https://ui.nuxt.com) | `npx nuxi init nuxt-ui-app -t ui` | [Stackblitz](https://stackblitz.com/github/nuxt/starter/tree/ui) / [CodeSandbox](https://codesandbox.io/p/github/nuxt/starter/ui) |

[v2-bridge](https://github.com/nuxt/starter/tree/v2-bridge) | [Nuxt 2](https://github.com/nuxt/nuxt/tree/2.x-dev) + [Bridge](https://github.com/nuxt/bridge) | `npx nuxi init nuxt-bridge-app -t v2-bridge` | [Stackblitz](https://stackblitz.com/github/nuxt/starter/tree/v2-bridge) / [CodeSandbox](https://codesandbox.io/p/github/nuxt/starter/v2-bridge-codesandbox) |

[v2](https://github.com/nuxt/starter/tree/v2) | [Nuxt 2](https://github.com/nuxt/nuxt/tree/2.x-dev) | `npx nuxi init nuxt2-app -t v2` | [Stackblitz](https://stackblitz.com/github/nuxt/starter/tree/v2-stackblitz) / [CodeSandbox](https://codesandbox.io/p/github/nuxt/starter/v2-codesandbox) |

## Contribution

Each template is maintained in a branch (see [all branches](https://github.com/nuxt/starter/branches)).

For improvements, please open a Pull Request to each individual branch.

**Note:** Please avoid commiting lock-files such as `yarn.lock` and `package-lock.json` to template branches!

## License

[MIT](./LICENSE) - Made with 💚