https://github.com/diem/reference-merchant

A demonstration merchant solution.
https://github.com/diem/reference-merchant

Last synced: 2 months ago
JSON representation

A demonstration merchant solution.

• Host: GitHub
• URL: https://github.com/diem/reference-merchant
• Owner: diem
• License: apache-2.0
• Created: 2020-11-11T01:53:10.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-24T19:43:19.000Z (almost 3 years ago)
• Last Synced: 2023-03-04T09:31:11.875Z (almost 2 years ago)
• Language: TypeScript
• Size: 1.85 MB
• Stars: 5
• Watchers: 22
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> **Note to readers:** On December 1, 2020, the Libra Association was renamed to Diem Association. The project repos are in the process of being migrated. All projects will remain available for use here until the migration to the new GitHub Organization is complete.

# Reference Merchant

Reference Merchant is an open-source project aimed at demonstrating integration of 

payments into an existing e-commerce solution. We tried to incorporate both technical and design

aspects not only to show how the different technical pieces fit together, but also demonstrate

thoughtful design, content, and best experience practices.

## Note to Developers

* Reference Merchant is a reference implementation, and not meant to be fully production grade.

* The project will continue to develop to include the different aspects of the evolving developer ecosystem.

## Project Organization

The project is separated into the following components:

* [Merchant](/merchant) - e-commerce website mock.

* [VASP](/vasp) - VASP fulfilling the merchant's payment requests.

* [Gateway](/gateway) - Nginx server routing requests to the various system components.

* [Liquidity](/liquidity) - Liquidity provider mock implementing simple liquidity functionality.

    This piece should be replaced by a service that provides your organization with needed

    liquidity functionality.

## Getting started

The project uses Docker containers to run its components. The containers are orchestrated using

docker-compose.

**System Requirements:**

* docker and docker-compose - Docker can be installed from the [web](https://www.docker.com/products/docker-desktop). If you are installing Docker for the first time on your system, be sure to run it at least once to have it configure itself and get `docker-compose` as a runnable command.

* python 3.7

* yarn

* react-scripts

* macOS: xcode cli tools  ```xcode-select --install```

Run the following commands in the repository root:

```shell script

scripts/lrm.sh setup_environment

scripts/lrm.sh build

scripts/lrm.sh develop

```

The merchant website will be available at http://localhost:8000

See `docker/docker-compose.yaml` for the setup details.