Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solana-labs/solana-payments-app
Solana Pay for Commerce Platforms
https://github.com/solana-labs/solana-payments-app
commerce payments shopify solana
Last synced: 2 months ago
JSON representation
Solana Pay for Commerce Platforms
- Host: GitHub
- URL: https://github.com/solana-labs/solana-payments-app
- Owner: solana-labs
- License: apache-2.0
- Created: 2023-02-24T23:19:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T02:08:59.000Z (9 months ago)
- Last Synced: 2024-09-28T09:42:37.541Z (2 months ago)
- Topics: commerce, payments, shopify, solana
- Language: TypeScript
- Homepage:
- Size: 11.7 MB
- Stars: 84
- Watchers: 8
- Forks: 45
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - solana-labs/solana-payments-app - Solana Pay for Commerce Platforms (TypeScript)
README
# Solana Payments App
documentation
|
walkthroughs
|
installation
|
live store
|
merchant login
Transact on Shopify using Solana
# Quickstart
Pre Setup Dependencies:
- [Docker Desktop](https://docs.docker.com/desktop/)
- [MySql](https://dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/)
Installation:
```
git clone https://github.com/solana-labs/solana-payments-app
yarn install
yarn setup:env
```
In `apps/backend-serverless/.env.dev`, add a Keypair secret for a wallet with SOL to pay for gas
In `apps/backend-serverless/.env.dev`, setup a [Helius API key](https://www.helius.dev)
To run:
```
yarn dev
yarn seed
```
## Testing
Use these links to test out the local development flow
[Local Merchant Portal](https://localhost:4004/install)
[Local Payment Simulation](https://localhost:4004/payment)
** Note **
These links redirect you to the frontend local deployments. We included sample development certificates in `backend-serverless` and `mock-shopify-serverless`, however, you might need to ignore browser errors. [Follow this guide](https://blog.simontimms.com/2021/10/12/serverless-offline-https/) to setup your own local dev certificates
For various helper scripts you might need while extending the code, in apps/backend-serverless, you can run
```
node --loader ts-node/esm scripts/nft-setup.ts
```
## Deploying
We use the [Serverless Framework](https://www.serverless.com), follow their directions to setup your appropriate aws & serverless credentials.
Ensure you setup the following dependencies in the respective `.env` files
- Sentry for logging
- TRM for scanning for suspicious wallets
- Helius for Solana rpc
- Coingecko for price data
- Persona for kyb
- Planetscale (recommended) or any mysql database provider
- AWS Lambda for Serverless deployment
- Vercel for frontend hosting
In `apps/backend-serverless`, deploy with
```
yarn deploy:production:purple
yarn deploy:production:green
```
In `apps/transaction-request-serverless`, deploy with
```
yarn deploy:production
```
(change production to staging for a staging environment)
_Make sure to use more secure JWTs in the .envs when deploying to staging and production_