mirror of https://github.com/jlengrand/adyen-web.git synced 2026-03-10 08:01:22 +00:00

Files

Andrea Szollossi 4b8ae0fbb7 Rephrase intro to the README

* Lead with the benefit for the merchant building blocks
* Give a clearer description of the two ways to integrate with Adyen 
Web.

2020-09-09 21:46:34 +02:00

2.8 KiB

Raw Blame History

Adyen Web

Adyen Web provides you with the building blocks to create a checkout experience for your shoppers, allowing them to pay using the payment method of their choice.

You can integrate with Adyen Web in two ways:

Web Drop-in: an all-in-one solution, the quickest way to accept payments on your website.
Web Components: one Component per payment method and combine with your own payments form logic.

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)

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

Start the development playground. This will start a local server on http://localhost:3020.

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.

2.8 KiB Raw Blame History