nuxt-directus-sdk

A Nuxt 3 Directus module that uses the Directus SDK to enhance your Nuxt application

• ✨  Release Notes
• 🔗  Documentation - Coming soon!

Features

• ⛰  Authentication out of the box
• 🚠  Type generation based on Directus collections
• 🔥  Typesafe Client Websockets enabled
• 🌉  Automatically configures Nuxt Image for directus
• 🗂️  Directus Admin panel added to Devtools

Quick Setup

1. Add nuxt-directus-sdk dependency to your project

# Using pnpm
pnpm add -D nuxt-directus-sdk

# Using yarn
yarn add --dev nuxt-directus-sdk

# Using npm
npm install --save-dev nuxt-directus-sdk

# Using bun
bun install --save-dev nuxt-directus-sdk

2. Add nuxt-directus-sdk to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-directus-sdk'
  ],
  directus: {
    url: '',
  }
})

3. OPTIONAL: Add an Directus admin token to .env file for additional goodies (Type generation, admin server directus)

DIRECTUS_ADMIN_TOKEN=""

That's it! You can now use Directus within your Nuxt app ✨

Development

# Install dependencies
bun install

# Generate type stubs
bun run dev:prepare

# Develop with the playground
bun run dev

# Build the playground
bun run dev:build

# Run ESLint
bun run lint

# Run Vitest
bun run test
bun run test:watch

# Release new version
bun run release