Nuxt BCMS
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: {
orgId: process.env.BCMS_ORG_ID,
instanceId: process.env.BCMS_INSTANCE_ID,
privateClientOptions: {
key: {
id: process.env.BCMS_PRIVATE_KEY_ID,
secret: process.env.BCMS_PRIVATE_KEY_SECRET,
},
options: {
injectSvg: true,
},
},
publicClientOptions: {
key: {
id: process.env.BCMS_PUBLIC_KEY_ID,
secret: process.env.BCMS_PUBLIC_KEY_SECRET,
},
options: {
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
Local 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