Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
AnwerAR authored Aug 27, 2024
1 parent ade1898 commit 5248092
Showing 1 changed file with 64 additions and 3 deletions.
67 changes: 64 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,65 @@
# checkout-web-sdk-code-demo

- Checkout Web [Documentation](https://checkoutdocs.payoneer.com/docs/getting-started-checkout-web-sdk)
- Demo [here](https://optile.github.io/checkout-web-sdk-code-demo/)

# Checkout Web SDK Code Demo

## Overview

Welcome to the Checkout Web SDK Code Demo! This repository contains a demo application showcasing the Checkout Web SDK, along with its documentation.
- **Checkout Web Documentation**: [Read the Docs](https://checkoutdocs.payoneer.com/docs/getting-started-checkout-web-sdk)
- **Live Demo**: [View the Demo](https://optile.github.io/checkout-web-sdk-code-demo/)

## Local Development Guide

To set up and run the project locally, follow these steps:

### 1. Clone the Repository

Clone this repository to your local machine:

git clone https://github.com/optile/checkout-web-sdk-code-demo.git

### 2. Install Dependencies

Navigate to the project directory and install the necessary dependencies:

npm install

### 3. Run the Development Server

Start the development server to view the project locally:

npm run dev
***Note: It's important to note the project runs on port 3000***

### 4. Build the Project

To create a production build of the project, run:

npm run build

### 5. Preview the Build

To preview the production build locally:

npm run preview

## Configuration

By default, this demo application uses an internal integration environment to generate list session. You can change the environment by passing `longId` and `env` as URL query parameters.

*Note: More info about generating backend payment session* [here](https://checkoutdocs.payoneer.com/docs/basic-integration-checkout-web-sdk)

**Example Usage:**

{BASE_URL}/?longId=longId&env=test

### Available Environments

Specify the environment using the `env` parameter. Available options include:

- `test` - Sandbox environment
- `live` - Production environment

## Deployment

This project is automatically deployed to GitHub Pages via GitHub Actions. Any push to the `main` branch triggers the deployment process.

0 comments on commit 5248092

Please sign in to comment.