CatnibDB 😼

CatnibDB Nuxt module to interface with CatnibDB back-end.

• ✨  Release Notes

Features

• 🐱  useCat()
• 🙀  useCats()
• 😸  usePage()
• 😺  usePages()
• 😽  <CatnibdbPage slug="home" />

Quick Setup

1. Add catnibdb dependency to your project

# Using pnpm
pnpm add -D catnibdb

# Using yarn
yarn add --dev catnibdb

# Using npm
npm install --save-dev catnibdb

2. Add catnibdb to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ["catnibdb"],
});

3. Add key and url in your .env file like this:

CATNIBDB_URL=""
CATNIBDB_KEY=""

or alternativly add them to Nuxt config like this:

export default defineNuxtConfig({
  modules: ["catnibdb"],

  catnibdb: {
    url: "",
    key: "",
  },
});

That's it! You can now use CatnibDB 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

# Release new version
npm run release