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: about 1 month ago
JSON representation
Secure, mobile-ready, instant and shareable point of sale
- Host: GitHub
- URL: https://github.com/lnbits/tpos
- Owner: lnbits
- License: mit
- Created: 2023-01-27T12:46:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T15:40:07.000Z (about 2 months ago)
- Last Synced: 2024-10-23T13:09:19.475Z (about 2 months ago)
- Language: HTML
- Size: 1.53 MB
- Stars: 14
- Watchers: 5
- Forks: 14
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-lnbits - TPoS - Mobile ready point-of-sale terminal (Uncategorized / Uncategorized)
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\
3. Open TPOS on the browser\
4. Present invoice QR to customer\
## Receiving Tips
1. Create or edit an existing TPOS and activate _Enable tips_\
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**\
4. A new dialog will show to define a tip\
- select the % or choose _Round to_ to round the value\
5. Present the invoice to the customer, with the updated amount with the tip\
- after payment, the tip amount is sent to the defined wallet (for example an employees wallet) and the rest to the main wallet\
## 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\
- you can add an item
- delete all items
- import/export items from a JSON
2. Clicking the _Add Item_ fill the Item details\
- 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)\
Click the items _Add_ button, to add to a "cart" or a total.
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.\
## OTC ATM functionality
1. Create or edit an existing TPOS and activate _Enable selling bitcoin_\
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\
4. Set amount to sell and click **OK**\
5. Show the LNURLw QR code to the buyer\
6. After successful withdraw, the green check will show and TPOS exists ATM mode\
## Tax settings
For tax settings, by default tax is included in the price. You'll need to set a default tax rate in percentage (ex: 13). If items have a tax value, as some products may have different tax (VAT usually), it overides the default value.
- **Tax Exclusive means tax is applied on top of the unit price.**
- **Tax Inclusive means the unit price includes tax.**
When using the normal keypad PoS, the default tax value is used, and tax value is always included in the value.