https://github.com/archetipo95/my-nuxt-starter

Nuxt 3 template ready to be used with integrations like Storybook, Tailwind, Vueuse, FormKit, HeadlessUI and many more!
https://github.com/archetipo95/my-nuxt-starter

formkit headlessui lodash nuxt storybook tailwindcss vue vueuse

Last synced: about 21 hours ago
JSON representation

Nuxt 3 template ready to be used with integrations like Storybook, Tailwind, Vueuse, FormKit, HeadlessUI and many more!

• Host: GitHub
• URL: https://github.com/archetipo95/my-nuxt-starter
• Owner: Archetipo95
• License: mit
• Created: 2023-02-15T15:28:51.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T09:45:53.000Z (2 months ago)
• Last Synced: 2024-09-08T11:47:45.394Z (2 months ago)
• Topics: formkit, headlessui, lodash, nuxt, storybook, tailwindcss, vue, vueuse
• Language: TypeScript
• Homepage: https://my-nuxt-experiments.netlify.app
• Size: 1.43 MB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🚀 Nuxt Starter

Welcome to the **Nuxt Starter** repository! This project is a modern web development starter kit using Nuxt 3 and a suite of powerful tools and libraries.

## 🌟 Description

- [![Netlify Status](https://api.netlify.com/api/v1/badges/4360c956-7cd2-44f1-aad8-33088c8d3637/deploy-status)](https://app.netlify.com/sites/my-nuxt-experiments/deploys) **Site**: [my-nuxt-experiments.netlify.app](https://my-nuxt-experiments.netlify.app)

- [![Netlify Status](https://api.netlify.com/api/v1/badges/4613b090-beaf-46a6-849d-bee5a39deeb9/deploy-status)](https://app.netlify.com/sites/my-nuxt-starter-storybook/deploys) **Storybook on Netlify**: [my-nuxt-starter-storybook.netlify.app](https://my-nuxt-starter-storybook.netlify.app)

- [![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@main/badge/badge-storybook.svg)](https://main--65f5b391c034b704dd98a557.chromatic.com) **Storybook on Chromatic**: [main--65f5b391c034b704dd98a557.chromatic.com](https://main--65f5b391c034b704dd98a557.chromatic.com)

## ✨ Features

1. ⚡ **Nuxt 3**

2. 🎨 **TailwindCSS** (@nuxtjs/tailwindcss)

3. 🛠️ **VueUse** (@vueuse/nuxt)

4. 📚 **Storybook 8**

5. 📦 **Lodash** (nuxt-lodash)

6. 🧩 **HeadlessUI** (nuxt-headlessui)

7. 📑 **FormKit** (@formkit/nuxt)

8. 🖼️ **Auto imported SVG icons** (vite + unplugin-icons)

9. 🌐 **Internationalization** (@nuxtjs/i18n)

10. ✒️ **Fonts** (@nuxt/fonts)

## 📝 To be added

- 🧪 **Testing**

- 🧹 **Linting** (Stylelint, ESLint)

- 💅 **Prettier**

## ⚙️ Setup

Make sure to install the dependencies:

```bash

pnpm install

```

## 🌐 Site

### 🛠️ Start development

(Served on http://localhost:3000)

    pnpm dev

### 📦 Build production

    pnpm build

## 📖 Storybook

### 🛠️ Start development

(Served on http://localhost:6006)

    pnpm storybook

### 📦 Build production

    pnpm build-storybook

### 🌍 Serve locally the production

    pnpm serve-storybook

## 🚀 Deploy on Netlify

### 🌐 Site

- **Build command**: `pnpm build`

- **Publish directory**: `dist`

### 📖 Storybook

- **Build command**: `pnpm build && pnpm build-storybook`

- **Publish directory**: `storybook-static`

---

Feel free to contribute and make this project even more awesome! 🎉