1.0.0 • Published 4 years ago

nuxt-bigcommerce v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

nuxt-bigcommerce

npm version npm downloads Github Actions CI Codecov License

BigCommerce Module for Nuxt.js

📖 Release Notes

Setup

  1. Add nuxt-bigcommerce dependency to your project
yarn add nuxt-bigcommerce # or npm install nuxt-bigcommerce
  1. Add nuxt-bigcommerce to the modules section of nuxt.config.js
/// nuxt.config.js
{
  modules: [
    // Simple usage
    'nuxt-bigcommerce',

    // With options
    ['nuxt-bigcommerce', { /* module options */ }]
  ]
}

Or a separate section bigcommerce for module options:

// nuxt.config.js
{
  modules: [
    // Simple usage
    'nuxt-bigcommerce',
  ],
  bigcommerce: {
    /* all other options */
  }
}
  1. Test fetching data from BigCommerce
await this.$bigcommerce.product.getProductById(77);

Documentation

Move to the docs directory:

cd docs

Install dependencies and start the project in development mode:

yarn && yarn dev

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using npm run dev

License

MIT License

Copyright (c) Baroshem jakub.andrzejewski.dev@gmail.com