Twitch0125 / nuxt-zookeeper-module

🚧 UNDER CONSTRUCTION 🚧

what I plan for this module

• This module will be able to retrieve zookeeper variables on server start and save them to in in-memory unstorage instance.
• variables should be private by default
  • ⚠️ We can't save to runtimeConfig because that doesn't change at runtime.
  • We can save to storage under a "public" prefix and use useState to provide them client side
  • Or we can provide a /__zookeeper__/variables api route and provide some utils for fetching from that endpoint
• hooks for zookeeper events

uses node-zookeeper-client for the zookeeper client

Possible future enhancements

• Listening to zookeeper variable changes
• zookeeper unstorage layer

nuxt-zookeeper-module

My new Nuxt module for doing amazing things.

• ✨  Release Notes

Features

• ⛰  Foo
• 🚠  Bar
• 🌲  Baz

Quick Setup

1. Add nuxt-zookeeper-module dependency to your project

# Using pnpm
pnpm add -D nuxt-zookeeper-module

# Using yarn
yarn add --dev nuxt-zookeeper-module

# Using npm
npm install --save-dev nuxt-zookeeper-module

2. Add nuxt-zookeeper-module to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-zookeeper-module'
  ]
})

That's it! You can now use nuxt-zookeeper-module in your Nuxt app ✨

Development

# 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