Skip to content

Commit

Permalink
Update README by fixing broken links and add the option to deploy to …
Browse files Browse the repository at this point in the history
…Heroku. Add app.json manifest file.
  • Loading branch information
pabloai committed Aug 9, 2019
1 parent bdc2b87 commit 6682a9c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
@@ -1,9 +1,9 @@
# Checkout Components sample code

> ⚠️ **This repository is for demo purposes only**
# Adyen Components sample code

![Adyen Checkout Components Sample Code](screenshot.png)

> ⚠️ **This repository is for demo purposes only**
## Requirements

To run this project, **create** a `.env` file on your project's root folder following the example on `.env.default`.
Expand All @@ -13,7 +13,7 @@ MERCHANT_ACCOUNT=MyMerchantAccount
CHECKOUT_APIKEY=MY_CHECKOUT_API_KEY
```

These variables can be found in Adyen Customer Area. For more information, visit our [Getting Started guide](https://docs.adyen.com/developers/get-started-with-adyen/create-a-test-account).
These variables can be found in Adyen Customer Area. For more information, visit our [Get started with Adyen guide](https://docs.adyen.com/payments-essentials/get-started-with-adyen).

## Installation

Expand All @@ -28,9 +28,14 @@ $ ./start.sh

A PHP server will start on `http://localhost:3000`.

### Deploying this example to Heroku

Alternatively, you can install this example by using this shortcut to deploy to Heroku:<br/>
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/Adyen/adyen-components-js-sample-code)

## Documentation

For the complete integration guide, refer to the [Checkout Components documentation](https://docs.adyen.com/checkout/components-web/).
For the complete integration guide, refer to the [Web Components documentation](https://docs.adyen.com/checkout/components-web/).

## License

Expand Down
23 changes: 23 additions & 0 deletions app.json
@@ -0,0 +1,23 @@
{
"name": "Adyen Components Sample Code",
"description": "A php server example containing our Javascript SDK",
"keywords": [
"Adyen",
"Checkout",
"Components",
"Dropin",
"Web",
"JavaScript",
"payments"
],
"website": "https://www.adyen.com/",
"repository": "https://github.com/Adyen/adyen-components-js-sample-code",
"env": {
"MERCHANT_ACCOUNT": {
"description": "Your merchant account"
},
"CHECKOUT_APIKEY": {
"description": "Your Checkout API key"
}
}
}

0 comments on commit 6682a9c

Please sign in to comment.