nuxt-adyen-module

Adyen Payment Module for Nuxt.js

Usage no npm install needed!

<script type="module">
  import nuxtAdyenModule from 'https://cdn.skypack.dev/nuxt-adyen-module';
</script>

README

nuxt-adyen-module logo

nuxt-adyen-module

npm version npm downloads Github Actions CI Codecov License

Adyen Module for Nuxt.js

📖 Release Notes

Setup

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

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

Or a separate section adyen for module options:

// nuxt.config.js
{
  modules: [
    // Simple usage
    'nuxt-adyen-module',
  ],
  adyen: {
    clientKey: '<your-adyen-client-key>',
    /* all other options */
  }
}

For all available module options, please refer to options

  1. Import AdyenCheckout component
import AdyenCheckout from 'nuxt-adyen-module/src/runtime/AdyenCheckout.vue';
  1. Provide all necessary data to the AdyenCheckout component like props and props functions described here

Testing

You can test the Adyen Checkout by using the following card:

  • Card Number: 2222 4000 7000 0005
  • Expiry Date: 03/2030
  • CVC3: 737

Or any other listed here:

https://docs.adyen.com/development-resources/test-cards/test-card-numbers#mastercard

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