Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/lnbits/tpos

Secure, mobile-ready, instant and shareable point of sale
https://github.com/lnbits/tpos

Last synced: 12 days ago
JSON representation

Secure, mobile-ready, instant and shareable point of sale

Lists

README

        

# TPoS - [LNbits](https://github.com/lnbits/lnbits) extension

For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions)

## A Shareable PoS (Point of Sale) that doesn't need to be installed and can run in the browser!

An easy, fast and secure way to accept Bitcoin, over Lightning Network, at your business. The PoS is isolated from the wallet, so it's safe for any employee to use. You can create as many TPOS's as you need, for example one for each employee, or one for each branch of your business.

### Usage

1. Enable extension
2. Create a TPOS\
![create](https://imgur.com/8jNj8Zq.jpg)
3. Open TPOS on the browser\
![open](https://imgur.com/LZuoWzb.jpg)
4. Present invoice QR to customer\
![pay](https://imgur.com/tOwxn77.jpg)

## Receiving Tips

1. Create or edit an existing TPOS and activate _Enable tips_\
![tips](https://i.imgur.com/VRKPNop.png)
2. Fill in the necessary fields:\
- select a wallet to receive tips in
- define the tip (percentage)
- hit _Enter_ after every option
- if no values are defined, a default _Rounding_ option will be available. Round the check to a defined value.
3. When using the TPOS, set a value to receive as normal and hit **OK**\
![tip amnt](https://i.imgur.com/Vyh0kqx.png)
4. A new dialog will show to define a tip\
![set tip 1](https://i.imgur.com/1xxrAse.png)
- select the % or choose _Round to_ to round the value\
![set tip 2](https://i.imgur.com/gv48S8U.png)
5. Present the invoice to the customer, with the updated amount with the tip\
![pay tip](https://i.imgur.com/WuaRzph.png)
- after payment, the tip amount is sent to the defined wallet (for example an employees wallet) and the rest to the main wallet\
![paym 1](https://i.imgur.com/zvDf1y5.png)

## Add Items to PoS

You can add items to a TPoS and use it on a list.

1. After creating a TPos, or on an existing TPoS, click the expand button\
![items](https://i.imgur.com/V468a7q.png)

- you can add an item
- delete all items
- import/export items from a JSON

2. Clicking the _Add Item_ fill the Item details\
![add item](https://i.imgur.com/dNQGFXa.png)

- title and price are mandatory

3. Or you can import a JSON with your products, using the format:

```
[
{
"image": "https://image.url",
"price": 1.99,
"title": "Item 1",
"tax": 3.5,
"disabled": false
},
{
"price": 0.99,
"title": "Item 2",
"description": "My cool Item #2",
},
...
]
```

After adding your products, when launching your TPoS, if there are products, it will default to the items view (PoS view)\
![pos](https://i.imgur.com/Adh0fdO.png)

Click the items _Add_ button, to add to a "cart" or a total.
![pos add](https://i.imgur.com/uZCQpZD.png)

When done, click _Pay_ to show the invoice for customer to pay, or choose the tip if you have it set. If you need the regular TPoS, click the button on the bottom.

**There's also a `+` button on the regular TPoS**
On the regular TPoS you can also add value to a total. Enter a value and click the `+` button. Keep doing it until you're done. After that click _OK_ as usual.\
![plus](https://i.imgur.com/DSOusVA.png)

## OTC ATM functionality

1. Create or edit an existing TPOS and activate _Enable selling bitcoin_\
![atm](https://i.imgur.com/WF3jiFb.png)
2. Fill in the necessary fields:

- set a maximum withdrawable per day
- define a PIN to access the functionality
- define a _cool down_ period between withdraws, to avoid exploitation (min. 1 minute)

3. When using the TPOS, you'll see the **ATM** button, click and enter PIN\
![atm pin](https://i.imgur.com/5QMYXX7.png)
4. Set amount to sell and click **OK**\
![atm amount](https://i.imgur.com/V3jlfhV.png)
5. Show the LNURLw QR code to the buyer\
![atm withdraw](https://i.imgur.com/rYXtn93.png)
6. After successful withdraw, the green check will show and TPOS exists ATM mode\
![atm success](https://i.imgur.com/FaHltvW.png)