ki9
/
pago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 📝 Improve README language

main
Keith Irwin 2024-04-18 17:53:21 -06:00
parent 1c141d83af
commit d550f288c0
Signed by: ki9
GPG Key ID: DF773B3F4A88DA86
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -2,7 +2,7 @@
A lightweight monero payment gateway that can be embedded into any website. "pago" is esperanto for "payment", just as "monero" is esperanto for "money".
## Project overview
## Overview
There are three components to pago, shown in the big square at the bottom in this diagram:
@ -38,3 +38,16 @@ walletRPC│ │walletRPC
The processor api is an express/node.js server and the two frontends have a single lightweight dependency: the knockoutJS microframework.
There is no database. Data are stored in the wallet file, which should be backed up like any data.
## Installation
Copy sample files to environment files:
```sh
cp docker-compose.override.sample.yml docker-compose.override.yml
cp sample.env .env
```
Configure `.env` and `docker-compose.override.yml` according to your setup (they are commmented).
Docker is not required; you can also run `npm run start` to run a server on port 80. You will need to run a wallet-rpc service too.