@bageldb/bageldb-nuxt

BagelDB Client for NuxtJS

BagelDB is a content management system with flexible database with user login for doing amazing things.

• ✨  Release Notes
• 🏀 Online playground

Features

• ⛰   Flexible Database
• 🚠   Simplicity First
• 🌲   Powerful Editor Tools

Quick Setup

1. Add @bageldb/bageldb-nuxt dependency to your project

# Using pnpm
pnpm add @bageldb/bageldb-nuxt

# Using yarn
yarn add @bageldb/bageldb-nuxt

# Using npm
npm i @bageldb/bageldb-nuxt

# Using bun
bun i @bageldb/bageldb-nuxt

2. Add @bageldb/bageldb-nuxt to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    '@bageldb/bageldb-nuxt',
    {
      token: process.env.NUXT_ENV_BAGEL_TOKEN,
      alias: "db", // (optional)
      exposePublicClient: true // (optional) - this will expose the client to the browser
    }
  ]
})

The default alias is $db but can be set easily in the import. Two instances can be used in one project, but they must have different instances.

** in older versions it used to default to $bageldb

Use It

The db instance can be accessed globally anywhere in the code

retreive it via the context:

export default {
  async asyncData({ $db }) {
    let { data: books } = await $db.collection("books").get();
    return { books };
  },
};

Authentication

Using Auth with Nuxt.js works the same as evey BagelDB js framework, by using the users() method.

export default {
  methods: {
    async login(email, password) {
      await this.$db.users().validate(email, password);
    },
    async logout() {
      await this.$db.users().logout();
    },
    async signUp(email, password, userName) {
      let userID = await this.$db
        .users()
        .create(email, password)
        .catch(console.log);
      // create an item with the user's id to store more information about the user.
      await this.$db.collection("users").item(userID).set({ email, userName });
    },
  },
};

every call made after that will use the Auth token stored in the cookie.

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