nuxt-neo4j

Neo4jの強力なグラフデータベースをNuxtアプリケーションに簡単に統合できます！

79ダウンロード•17スター•v0.0.4

arashsheyda

Nuxt Neo4j

Neo4jの強力なグラフデータベースをNuxtアプリケーションに簡単に統合できます！

✨ リリースノート

機能

簡単な統合: たった一行の設定でデータベースをセットアップできます。
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

nuxt.config.tsのmodulesセクションに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