Nuxt BCMS

BCMS integration for Nuxt.

• ✨  Release Notes
• 📖  Documentation

Features

• Seamless integration with BCMS
• Out of the box components for rendering BCMS Images and content
• Automatic TypeScript types generation from your BCMS
• Easy access to BCMS Client API on server and client side
• Support for Private and Public API Keys

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add bcms

Then in your nuxt.config.ts file, add BCMS configuration. You can find configuration information on BCMS dashboard in the API Keys section.

export default defineNuxtConfig({
    modules: ['@thebcms/nuxt'],
    // ...
    bcms: {
        privateClientOptions: {
            id: process.env.BCMS_API_KEY,
            injectSvg: true,
        },
        publicClientOptions: {
            id: process.env.NUXT_PUBLIC_BCMS_API_KEY,
            injectSvg: true,
        },
    },
});

That's it! You can now use BCMS in your Nuxt app ✨

For more information on how to use BCMS with Nuxt, check out the documentation.

Contribution

# 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