enterprise-widget-sdk

A collection of tools for seamless setup of Enterprise widgets in partner applications.

Table of Contents

1. About The Project
2. Getting Started
   • Project Structure
   • Installation
3. Contributing

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.

(back to top)

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: The implementation of the Payment Widget SDK for the web.
• projects/widget-test-app: A test application for all widget SDKs.

Installation

This project uses 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

git clone https://github.com/uphold/enterprise-widget-sdk.git && cd enterprise-widget-sdk

2. Use the required Node version

nvm use

Note: If you don't use NVM, please ensure you have a compatible Node version installed on your machine.

3. Install dependencies

npm install

4. Verify that everything runs without issues

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.

(back to top)

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 <prefix>/<branch-name>:
   • 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 <prefix>/<branch-name>)
4. Open a Pull Request

(back to top)