https://github.com/uphold/enterprise-widget-sdk
A collection of tools for seamless setup of Enterprise widgets in partner applications.
https://github.com/uphold/enterprise-widget-sdk
Last synced: 2 months ago
JSON representation
A collection of tools for seamless setup of Enterprise widgets in partner applications.
- Host: GitHub
- URL: https://github.com/uphold/enterprise-widget-sdk
- Owner: uphold
- Created: 2025-03-03T14:42:09.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-04-17T10:47:42.000Z (2 months ago)
- Last Synced: 2026-04-17T12:32:06.755Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 848 KB
- Stars: 1
- Watchers: 28
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
enterprise-widget-sdk
A collection of tools for seamless setup of Enterprise widgets in partner applications.
Table of Contents
## About The Project
A collection of SDKs for seamless integration with Enterprise Widgets. The SDKs are designed to be used in partner applications to provide a seamless experience for the end-user.
## Getting Started
Please ensure your machine is using the correct versions of Node.js and NPM before installing the project; otherwise, you may encounter installation issues. Check the `package.json` file for the required Node version.
### Project Structure
The project is organized as follows:
- [`packages/payment-widget-web-sdk`](./packages/payment-widget-web-sdk): The implementation of the Payment Widget SDK for the web.
- [`packages/travel-rule-widget-web-sdk`](./packages/travel-rule-widget-web-sdk): The implementation of the Travel Rule Widget SDK for the web.
- [`projects/widget-test-app`](./projects/widget-test-app/): A test application for all widget SDKs.
### Installation
This project uses [NPM Workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces) that allows for managing multiple packages within a single repository. The installation process will look for all workspaces and install its dependencies, and also create the necessary symlinks for internal dependencies.
#### 1. Clone the repo
```sh
git clone https://github.com/uphold/enterprise-widget-sdk.git && cd enterprise-widget-sdk
```
#### 2. Use the required Node version
```sh
nvm use
```
_Note: If you don't use NVM, please ensure you have a compatible Node version installed on your machine._
#### 3. Install dependencies
```sh
npm install
```
#### 4. Verify that everything runs without issues
```js
npm run lint
npm run typecheck
npm test
```
#### 5. Running a project
Each project has its own README with specific instructions on how to run it.
Please refer to the project's README for more information.
## Contributing
Your contributions are **greatly appreciated**. After the initial setup, you can follow the steps below to contribute to the project:
1. Create a branch with the convention `/`:
- **feature:** (`git checkout -b feature/amazing-feature`)
- **support:** (`git checkout -b support/config-task`)
- **enhancement:** (`git checkout -b enhancement/improve-something`)
- **bugfix:** (`git checkout -b bugfix/annoying-bug`)
2. Commit your changes (`git commit -m 'Summary message of the changes introduced'`)
3. Push to the branch (`git push origin /`)
4. Open a Pull Request