feat: add minimal Nuxt example with nuxt-query

Author: peterbud

examples/minimal/.gitignore

@@ -0,0 +1,24 @@
+# Nuxt dev/build outputs
+.output
+.data
+.nuxt
+.nitro
+.cache
+dist
+
+# Node dependencies
+node_modules
+
+# Logs
+logs
+*.log
+
+# Misc
+.DS_Store
+.fleet
+.idea
+
+# Local env files
+.env
+.env.*
+!.env.example

examples/minimal/README.md

@@ -0,0 +1,75 @@
+# Nuxt Minimal Starter
+
+Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+
+## Setup
+
+Make sure to install dependencies:
+
+```bash
+# npm
+npm install
+
+# pnpm
+pnpm install
+
+# yarn
+yarn install
+
+# bun
+bun install
+```
+
+## Development Server
+
+Start the development server on `http://localhost:3000`:
+
+```bash
+# npm
+npm run dev
+
+# pnpm
+pnpm dev
+
+# yarn
+yarn dev
+
+# bun
+bun run dev
+```
+
+## Production
+
+Build the application for production:
+
+```bash
+# npm
+npm run build
+
+# pnpm
+pnpm build
+
+# yarn
+yarn build
+
+# bun
+bun run build
+```
+
+Locally preview production build:
+
+```bash
+# npm
+npm run preview
+
+# pnpm
+pnpm preview
+
+# yarn
+yarn preview
+
+# bun
+bun run preview
+```
+
+Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

examples/minimal/app.vue

@@ -0,0 +1,37 @@
+<script lang="ts" setup>
+const getUsers = async () => {
+  return await $fetch('https://jsonplaceholder.typicode.com/users')
+}
+
+const { isPending: isPending, data: users } = useQuery({
+  queryKey: ['users'],
+  queryFn: getUsers,
+})
+</script>
+
+<template>
+  <h1>Users</h1>
+  <div v-if="isPending">
+    Loading...
+  </div>
+  <div
+    v-else
+    :style="{
+      display: 'grid',
+      gap: '0.5rem',
+      paddingLeft: '0.5rem',
+    }"
+  >
+    <div
+      v-for="user in users"
+      :key="user.id"
+      :style="{
+        cursor: 'pointer',
+        paddingTop: '0.25rem',
+        borderRadius: '0.125rem',
+      }"
+    >
+      {{ user.name }} ({{ user.email }})
+    </div>
+  </div>
+</template>

examples/minimal/nuxt.config.ts

@@ -0,0 +1,9 @@
+// https://nuxt.com/docs/api/configuration/nuxt-config
+export default defineNuxtConfig({
+  modules: ['@peterbud/nuxt-query'],
+  devtools: { enabled: true },
+  compatibilityDate: '2024-11-01',
+  nuxtQuery: {
+    autoImports: ['useQuery', 'useMutation', 'useQueryClient'],
+  },
+})

examples/minimal/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "nuxt-query-minimal-example",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "nuxt build",
+    "dev": "nuxt dev",
+    "generate": "nuxt generate",
+    "preview": "nuxt preview",
+    "postinstall": "nuxt prepare"
+  },
+  "dependencies": {
+    "@peterbud/nuxt-query": "^0.0.5",
+    "nuxt": "^3.16.0",
+    "vue": "^3.5.13",
+    "vue-router": "^4.5.0"
+  }
+}

examples/minimal/public/favicon.ico

@@ -0,0 +1 @@
+

examples/minimal/public/robots.txt

@@ -0,0 +1,3 @@
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}

examples/minimal/server/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  // https://nuxt.com/docs/guide/concepts/typescript
+  "extends": "./.nuxt/tsconfig.json"
+}