Files
adyen-web/README.md
Andrea Szollossi b17ac43d00 Rephrase License section content and link to LICENSE file
* Make it easy for people to find the license file by linking to it.
* Saying that the repository is open source is redundant.
2020-09-08 22:16:08 +02:00

3.1 KiB

Adyen Web

npm

With Adyen Web you can help your shoppers pay with a payment method of their choice. It provides you with the building blocks you need to create a checkout experience.

You can integrate with Adyen in two ways, Drop-in and Components.

Installation

NPM

Install NPM package:

npm install @adyen/adyen-web --save

And import in your application:

import AdyenCheckout from '@adyen/adyen-web';
import '@adyen/adyen-web/dist/adyen.css';

Script tag

Adyen Web can also be imported with a <script> tag, refer to the documentation for instructions.

Please note:

We only provide full support when using one of these methods of installation. Modifications to the code base should be made via a pull request or by creating an issue.

Rationale

We have open-sourced Adyen Web for the following reasons:

  • Allowing developers to have easier access to the source code for quick and easy debugging
  • Allowing developers to freely raise bugs/issues/feature requests
  • Providing developers with a way to be informed and updated whenever a new release is made available (i.e. "Watching" the repository)

See also

Development environment

Follow these steps to run our development playground:

  • Clone this repository and navigate to the root of the project.
  • Create a .env file on your project's root folder following the example on .env.default and fill in the necessary environment variables.
  • Install all dependencies by running:
yarn install
yarn start

Branch organization

We merge every pull request to the master branch. We aim to keep master in good shape, which allows us to release a new version whenever we need to.

Support

If you have a feature request, or spotted a bug or a technical problem, create an issue here. For other questions, contact our support team.

License

This repository is available under the MIT license.