@paystack/checkout-js 1.13.0 → 2.0.0-dev.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -23
- package/dist/checkout.js +14 -28
- package/es/checkout.js +6279 -13044
- package/lib/checkout.js +6287 -13052
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -4,45 +4,52 @@ This is the client-side JS library for billing customers with Paystack. It makes
|
|
|
4
4
|
|
|
5
5
|
It is used in Checkout, Paystack's proprietary checkout form.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
# Documentation
|
|
7
|
+
## Documentation
|
|
9
8
|
|
|
10
9
|
See the [Checkout JS public docs](./PUBLIC_DOCS.md) and [development docs](./DEV_DOCS.md)
|
|
11
10
|
|
|
11
|
+
## Setup
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
Clone this repository
|
|
16
|
-
|
|
17
|
-
git clone git@github.com:PaystackHQ/checkout-js.git
|
|
18
|
-
|
|
19
|
-
Install dependencies with:
|
|
13
|
+
Prerequisites
|
|
20
14
|
|
|
21
|
-
|
|
15
|
+
```bash
|
|
16
|
+
node >= 12.0.0
|
|
17
|
+
npm >= 6.0.0
|
|
18
|
+
```
|
|
22
19
|
|
|
20
|
+
Clone this repository
|
|
23
21
|
|
|
24
|
-
|
|
22
|
+
```bash
|
|
23
|
+
git clone git@github.com:PaystackHQ/checkout-js.git
|
|
24
|
+
```
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
Install dependencies with:
|
|
27
27
|
|
|
28
|
+
```bash
|
|
29
|
+
npm install
|
|
30
|
+
```
|
|
28
31
|
|
|
29
|
-
|
|
32
|
+
## Testing
|
|
30
33
|
|
|
31
34
|
Testing is done with Jest. To test your changes, run
|
|
32
35
|
|
|
33
|
-
|
|
34
|
-
|
|
36
|
+
```bash
|
|
37
|
+
npm test
|
|
38
|
+
```
|
|
35
39
|
|
|
36
|
-
|
|
40
|
+
## Build
|
|
37
41
|
|
|
38
42
|
Checkout JS is built with Rollup. To build, run the command
|
|
39
43
|
|
|
40
|
-
|
|
44
|
+
```bash
|
|
45
|
+
npm run build
|
|
46
|
+
```
|
|
41
47
|
|
|
42
48
|
You can also specify an environment to build for: `dev`, `staging`, or `production`. Configuration variables are set in `src/config.js`.
|
|
43
49
|
|
|
50
|
+
Be sure to check out the `stats.html` file at the root of the project to get a sense of the impact of your changes on bundle size.
|
|
44
51
|
|
|
45
|
-
|
|
52
|
+
## Deployment
|
|
46
53
|
|
|
47
54
|
Checkout JS is deployed to three environments:
|
|
48
55
|
|
|
@@ -50,12 +57,10 @@ Checkout JS is deployed to three environments:
|
|
|
50
57
|
- Production: [https://js.paystack.co/v1/checkout.js](https://js.paystack.co/v1/checkout.js)
|
|
51
58
|
- npm: [@paystack/checkout-js](https://npmjs.com/package/@paystack/checkout-js)
|
|
52
59
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
# Releases
|
|
60
|
+
## Releases
|
|
56
61
|
|
|
57
62
|
Checkout JS is automatically packaged and published to the NPM registry on every push to the `master` and `dev` branches.
|
|
58
63
|
|
|
59
|
-
The `master` branch is
|
|
64
|
+
The `master` branch is published under the `latest` tag so it can be installed by running `npm i @paystack/checkout-js@latest` while the `dev` branch is published under the `dev` tag so it can be installed using `npm i @paystack/checkout-js@dev`
|
|
60
65
|
|
|
61
|
-
All published versions are listed here on NPM https://www.npmjs.com/package/@paystack/checkout-js
|
|
66
|
+
All published versions are listed here on NPM <https://www.npmjs.com/package/@paystack/checkout-js>
|