Nuxt module for BCMS
npm install nuxt-bcms[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
- ✨ Release Notes
- 📖 Documentation
- 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
Install the module to your Nuxt application with one command:
``bash`
npx nuxi module add bcms
Then in your nuxt.config.ts file, add BCMS configuration. You can findAPI Keys
configuration information on BCMS dashboard in the section.
`ts`
export default defineNuxtConfig({
modules: ['nuxt-bcms'],
// ...
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.
Local development
`bashInstall dependencies
npm install
npm run dev:prepare
npm run dev
npm run dev:build
npm run lint
npm run test
npm run test:watch
npm run release
`
[npm-version-src]: https://img.shields.io/npm/v/nuxt-bcms/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nuxt-bcms
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-bcms.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npm.chart.dev/nuxt-bcms
[license-src]: https://img.shields.io/npm/l/nuxt-bcms.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nuxt-bcms
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com
``