Nuxt Neo4j

強固な Neo4j グラフデータベースを Nuxt アプリケーションに難なく統合できます!

✨ リリースノート

機能

容易な統合: 構成はたった1行でデータベースを設定します。
DevTools 対応: Nuxt DevTools から neo4j のワークスペースにアクセスできるようになります!
使いやすい: このモジュールはデータベースと容易にやり取りするための useDriver 関数を提供します。
開発者の体験: このモジュールは公式の neo4j-driver を使用しているため、typescript をフルサポートしています。

セットアップ

プロジェクトに nuxt-neo4j 依存を追加します。

# Using pnpm
pnpm add -D nuxt-neo4j

# Using yarn
yarn add --dev nuxt-neo4j

# Using npm
npm install --save-dev nuxt-neo4j

modules セクションの nuxt.config.ts に nuxt-neo4j を追加します。

export default defineNuxtConfig({
  modules: [
    'nuxt-neo4j',
  ],
})

以上です! Nuxt アプリで Nuxt Neo4j を使用できます ✨

構成

export default defineNuxtConfig({
  neo4j: {
    uri: 'string', // @default: process.env.NEO4J_URI
    auth: {
      type: 'string', // @default: 'basic'
      username: 'string', // @default: process.env.NEO4J_USERNAME
      password: 'string', // @default: process.env.NEO4J_PASSWORD
    },
  },
})

使用法

構成したら、Nuxt アプリケーションでモジュールが提供する Neo4j ドライバーの使用を開始できます。以下は使用方法の例です。

export default defineEventHandler(async () => {
  const { records } = await useDriver().executeQuery('MATCH (q:User) RETURN q LIMIT 25;')
  return records
})

詳細については、neo4j ドキュメントを確認してください。

開発

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint

# Run Vitest
pnpm run test
pnpm run test:watch

# Release new version
pnpm run release