Nuxt GQF

A Nuxt binding for @teages/gqf.

• ✨  Release Notes
• 🏀 Online playground
• 📖  Documentation

Features

• 🔒  Write queries with type safety and type hints.
• 🚀  No need to scan your source code, no code generation during HMR.
• ❤️  he experience of using gqf is very similar to writing plain GraphQL queries.
• 🌐  Working for most clients with TypedDocumentNode.

Quick Setup

1. Add @teages/nuxt-gqf dependency to your project

# ✨ Auto-detect
npx nypm install @teages/nuxt-gqf

# Using npm
npm install @teages/nuxt-gqf

# Using yarn
yarn add @teages/nuxt-gqf

# Using pnpm
pnpm add @teages/nuxt-gqf

# Using bun
bun install @teages/nuxt-gqf

2. Add @teages/nuxt-gqf to the modules section of nuxt.config.ts, and configure it:

export default defineNuxtConfig({
  modules: [
    '@teages/nuxt-gqf'
  ],

  gqf: {
    clients: [
      'https://your-graphql-endpoint',
    ],
  },
})

Contribution

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release