Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paypal/paypal-messaging-components
PayPal JavaScript SDK - messaging components
https://github.com/paypal/paypal-messaging-components
credit financing messaging paypal
Last synced: 6 days ago
JSON representation
PayPal JavaScript SDK - messaging components
- Host: GitHub
- URL: https://github.com/paypal/paypal-messaging-components
- Owner: paypal
- License: apache-2.0
- Created: 2019-05-28T16:10:52.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-11T22:21:23.000Z (22 days ago)
- Last Synced: 2024-12-20T17:09:05.622Z (13 days ago)
- Topics: credit, financing, messaging, paypal
- Language: JavaScript
- Size: 302 MB
- Stars: 37
- Watchers: 30
- Forks: 57
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PayPal Credit Messaging
---
[](https://github.com/paypal/paypal-messaging-components/actions/workflows/snapshotCompare.yml) [](https://david-dm.org/paypal/paypal-messaging-components) [](https://david-dm.org/paypal/paypal-messaging-components?type=dev)
A messaging component allowing easy integration of PayPal Credit Messages onto your site.
## Dev Docs
See **[developer.paypal.com/docs/business/pay-later/integrate/](https://developer.paypal.com/docs/business/pay-later/integrate/)**
---
## Development
Please feel free to follow the [Contribution Guidelines](./CONTRIBUTING.md) to contribute to this repository. PRs are welcome, but for major changes please raise an issue first.
### Quick Setup
Set up your env:
```bash
npm install
```
Run tests:
```bash
npm test
```
Run in dev mode:
```bash
npm start
```
## Creating a Bundle
```
npm run build
```
Options
- `-v` - version, optional
- `-e` - environment, one of `production`, `sandbox` or `stage`
- `-m` - module, optional, one of `library`, `components`, or `render`
- `-t` - tag, optional, name of the stage tag
- `-s` - testEnv, optional, link to a test environment
The command you'll most likely need to use is
```
npm run build -- -t stage-tag-name -s test-environment-link
```
## Scripts
- `build`
- runs [semantic-release/assets.sh](./scripts/semantic-release/assets.sh) to build assets for all environments in `dist/`
- `build:` where `` is `stage`, `sandbox`, or `production`
- runs webpack with `NODE_ENV=`
- `build:analyze`
- runs [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) in static gzip mode
- `build:demo`
- runs webpack with `env.demo` set
- `dev`
- runs webpack-dev-server with `TARGET=sdk`, `NODE_ENV=local`, `STAGE_TAG=local`
- `dev:` where `` is `standalone`, `modal`, or `lander`
- runs webpack-dev-server with `TARGET=`, `NODE_ENV=local`, `STAGE_TAG=local`
- note: `modal` uses `TARGET=standalone-modal`
- `dev:` where `` is `stage`, `sandbox`, or `production`
- runs webpack-dev-server with `TARGET=standalone` and `NODE_ENV=`
- `lint`
- checks our codebase for style issues
- `preinstall`
- runs automatically on `npm install` and removes `node_modules/`
- `start`
- runs `npm run dev`
- `test`
- runs all unit tests
- `test:` where `` is `func`, `func:nosnaps` or `func:ciupdate`
- `func` runs all snapshot functional tests
- `func:nosnaps` runs all non-snapshot functional tests
- `func:ciupdate` updates all snapshots generated by functional tests
## Testing
### Functional
1. Run `npm run dev:ci` in one command line instance
2. In a second window run the below command, which runs tests for a specific `integrationType`
- `integrationType` is one of: `api`, `sdk`, `standalone`, or `webpage`
```
CONFIG_PATH={locale}/{account} npm run test:func:snapshots -- --testPathPattern {integrationType}
```
Example
```
CONFIG_PATH=US/DEV_US_MULTI npm run test:func:snapshots -- --testPathPattern sdk
```
Alternatively, you can remove `-- --testPathPattern {integrationType}` and just run the following to run tests on an account for all integration types.
```
CONFIG_PATH={locale}/{account} npm run test:func:snapshots
```
### Stage
#### For PayPal Internal Testing Only:
To test against PayPal's standard stage url, ensure that the demo page contains the following script, then run `npm run dev:stage`:
```javascript
//Change the value of the url and add the script to the demo page (i.e. standalone.html)
window.__TEST_ENV__ = "https://www.{PAYPAL_STAGE_URL_HERE}.com"
```
If you are looking to run against an alternative environment, set the `window.__TEST_ENV__` global to override the environment. **Please note, this is only available in development environments.**
```javascript
//Change the value of the test environment
window.__TEST_ENV__ = "https://www.te-test-env.com"
```
## Releasing
This package is published weekly, **Every Wednesday**. Please [view our Changelog](CHANGELOG.md) to stay updated with bug fixes and new features.