Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lautr/initium-nuxt

An opinionated starter for using Nuxt, Tailwind & Storybook.
https://github.com/lautr/initium-nuxt

Last synced: 5 days ago
JSON representation

An opinionated starter for using Nuxt, Tailwind & Storybook.

Awesome Lists containing this project

README

        

# lautr/initium-nuxt ๐Ÿ”ฅ


๐Ÿš€ Opinionated Nuxt, Tailwind & Storybook monorepo template


> inspired by [antfu vitesse nuxt](https://github.com/antfu/vitesse-nuxt3)

## Features
- [๐Ÿ’š Nuxt 3](https://v3.nuxtjs.org) - SSR, ESR, File-based routing, components auto importing, modules, etc.
- ๐Ÿค“ Optimized for VSCode usage
- [โšก๏ธ Vite](https://vitejs.dev/) - Instant HMR
- [โœจ Vitest](https://vitest.dev/guide/) - A blazing fast unit test framework
- [๐Ÿš Monorepo](https://pnpm.io/workspaces) - workspace setup using [pnpm](https://pnpm.io/)
- [๐ŸŒฌ๏ธ Tailwind 3](https://tailwindcss.com/) - the utility-first CSS framework
- [๐Ÿ–Œ๏ธ Storybook](https://storybook.js.org/) - build UI components and pages in isolation
- [๐ŸŒ“ Color Mode](https://github.com/nuxt-community/color-mode-module) - dark, light & custom mode integrated in Tailwind and Nuxt
- ๐Ÿ”ฅ The `` syntax
- [๐Ÿ State Management via Pinia](https://pinia.esm.dev), see [./stores/AuthStore.ts](./stores/AuthStore.ts)
- [๐Ÿงน Vue Macros](https://vue-macros.sxzz.moe/) Explore and extend more macros and syntax sugar to Vue.
- ๐Ÿ“ฅ APIs auto importing - for Composition API, VueUse, Components (localy & from design) and custom composables
- [๐Ÿฆพ TypeScript](https://www.typescriptlang.org/) - JavaScript, but strongly typed and better

## Plugins

### Nuxt Modules

- [VueUse](https://github.com/vueuse/vueuse) - collection of useful composition APIs.
- [ColorMode](https://github.com/nuxt-community/color-mode-module) - dark and Light mode with auto detection made easy with Nuxt.
- [Pinia](https://pinia.esm.dev/) - intuitive, type safe, light and flexible Store for Vue.
- [Nuxt Devools](https://devtools.nuxtjs.org/) - Unleash Nuxt Developer Experience.

## Commands
```
# install all dependencies of the monorepo
pnpm install
# start webapp & storybook
pnpm dev
# start dev webapp
pnpm webapp dev
# build webapp for prod
pnpm webapp build
# start webapp for prod
pnpm webapp start
# start dev storybook
pnpm design dev
```

## IDE

This Template is designed to provide great DX with [VS Code](https://code.visualstudio.com/) and [Volar](https://github.com/johnsoncodehk/volar).

## Usage

### GitHub Template

[Create a repo from this template on GitHub](https://github.com/lautr/initium-nuxt/generate).

### Clone to local

If you prefer to do it manually with the cleaner git history

```bash
npx degit lautr/initium-nuxt my-nuxt3-app
cd my-nuxt3-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```