https://github.com/nuxt-themes/starter

The best place to start your Nuxt Theme.
https://github.com/nuxt-themes/starter

Last synced: 7 days ago
JSON representation

The best place to start your Nuxt Theme.

• Host: GitHub
• URL: https://github.com/nuxt-themes/starter
• Owner: nuxt-themes
• Created: 2022-07-19T12:38:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T11:11:20.000Z (about 2 months ago)
• Last Synced: 2024-09-18T03:39:06.606Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://stackblitz.com/github/nuxt-themes/starter
• Size: 429 KB
• Stars: 89
• Watchers: 3
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nuxt Studio Theme Starter

Create a compatible [Nuxt Studio](https://nuxt.studio) theme with this GitHub template.

## Setup

Make sure to install the dependencies:

```bash

pnpm install

```

## Working on your theme

Your theme is at the root of this repository, it is exactly like a regular Nuxt project, except you can publish it on NPM.

The `.starters/default/` directory should help you on trying your theme during development.

Running `pnpm dev` will prepare and boot `.starters/default/` directory, which imports your theme itself.

## Distributing your theme

Your Nuxt theme is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.

To do so, you only have to check if `files` in `package.json` are valid, then run:

```bash

npm publish --access public

```

Once done, your users will only have to run:

```bash

npm install --save your-theme

```

Then add the dependency to their `extends` in `nuxt.config.ts`:

```ts

export default defineNuxtConfig({

  extends: 'your-theme'

})

```

## Development Server

Start the development server on http://localhost:3000

```bash

pnpm dev

```

## Production

Build the application for production:

```bash

pnpm build

```

Or statically generate it with:

```bash

pnpm generate

```

Locally preview production build:

```bash

pnpm preview

```

Checkout the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.