@paystack/checkout-js

Checkout JS

This is the client-side JS library for billing customers with Paystack. It makes it easy to create custom, secure payment experiences for merchant apps and websites. Checkout JS handles payment data encryption and transmission, this allows merchants to collect sensitive information such as credit card information without violating compliance.

It is used in Checkout, Paystack's proprietary checkout form.

Documentation

See the Checkout JS public docs and development docs

Installation

Clone this repository

git clone [e-mail]:PaystackHQ/checkout-js.git

Install dependencies with:

npm install

Development

The source code can be found in the src/ folder.

Testing

Testing is done with Jest. To test your changes, run

npm test

Build

Checkout JS is built with Rollup. To build, run the command

npm run build

You can also specify an environment to build for: dev, staging, or production. Configuration variables are set in src/config.js.

Deployment

Checkout JS is deployed to three environments:

• Staging: https://js-studio.paystack.co/v1/checkout.js
• Production: https://js.paystack.co/v1/checkout.js
• npm: @paystack/checkout-js

Continuous Integration is set up with Circle CI, and any push to master branch will attempt to update the npm module @paystack/checkout-js.

Automated deployment is done with Deploybot. We generate the build files dist/checkout.js for every push to master or dev. Pushes to the dev branch will deploy to the staging environment while master deploys to the production environment