elementsproject/nanopos

A simple Lightning :zap: point-of-sale system, powered by Lightning Charge

nanopos

A simple Lightning ⚡ point-of-sale system with a clean & minimal web UI.

• Optimized for places selling fixed-price items (like coffee shops, falafel stands or barber shops), but also has an option for billing custom amounts.
• Small codebase (~60 server-side LoC + ~70 client-side LoC), great starting point for developing your own Lightning Charge apps!

Powered by ⚡ Lightning Charge.

See demo video here ➤

Setup

$ npm install -g nanopos

$ edit items.yaml # see file format below

$ nanopos --items-path items.yaml --charge-token mySecretToken --currency USD
HTTP server running on localhost:9116

Running with Docker

Nanopos includes a Dockerfile to allow for fast setup using a docker container based on node:carbon. To run from the container with port 9116 exposed, first setup Lightning Charge, then build the image with:

$ docker build -t elements_project/nanopos .

and then run with:

$ docker run -p9116:9116 -e CHARGE_URL=http://[charge-url]/ -e CHARGE_TOKEN=[access-token] elements_project/nanopos

That's it! The web server should now be running on port 9116 and ready to accept payments.

Example items.yaml file

tea:
  price: 0.02 # denominated in the currency specified by --currency
  title: Green Tea # title is optional, defaults to the key

coffee:
  price: 1

bamba:
  price: 3

beer:
  price: 7

hat:
  price: 15

tshirt (S):
  price: 25
  metadata:
    shirt_size: S

The metadata object will be added into the metadata of invoices for this item.

CLI options

$ nanopos --help

  A simple Lightning point-of-sale system, powered by Lightning Charge.

  Usage
    $ nanopos [options]

  Options
    -c, --charge-url <url>      lightning charge server url [default: http://localhost:9112]
    -t, --charge-token <token>  lightning charge access token [required]

    -y, --items-path <path>     path to yaml file with item config [default: ./items.yaml, file is required]
    -x, --currency <currency>   currency to use for item prices [default: BTC]
    -m, --theme <name>          pick theme from bootswatch.com [default: yeti]
    -l, --title <name>          website title [default: Lightning Nano POS]
    --no-custom                 disable custom amount field [default: false]
    --show-bolt11               display bolt11 as text and button [default: false]

    -p, --port <port>           http server port [default: 9115]
    -i, --host <host>           http server listen address [default: 127.0.0.1]
    -h, --help                  output usage information
    -v, --version               output version number

  Example
    $ nanopos -t chargeSecretToken -x EUR -y items.yaml

License

MIT

nanopos's Issues

satoshi price calculation

Just curious..

how is nanopos calculating satoshi amount when requesting invoice generation from lightning-charge?
is there a link to current price of btc vs currency chosen?

thanks for comments!

dockerhub elements_project/nanopos not available

Error response from daemon: pull access denied for elements_project/nanopos, repository does not exist or may require 'docker login'

Would you like a logo?

Hi,
excelent work! Im a graphic designer and I would like to create a logo for nanopos. For free, no strings attached.

Will you provide me some feedback if I create something?

More of my contibutions to open source projects - https://busy.org/@andrejcibik

Installation help

Please guys, some one help me to install on centos 7.
@tbr_kz

Additionally show invoice as text

Right now the invoice is only displayed as QR code but if you have to copy and paste the invoice or if you're using the Tor browser (which doesn't display the QR codes by default) you want to see the invoice as text string.

Simple, lightweight page to show incoming payment history

So that there's some ability to look back and diagnose previous payments.

This has privacy implications when used for self-service payments on publicly accessible devices (as in the TLV bitcoin embassy), so it should be a togglable option or require some form of authentication.

Add option to display payment request in textual BOLT11 format?

nanopos is usually expected to be run on a tablet and presented to the customer for QR scanning, but showing the BOLT11 request too might be useful for some use-cases. Could be added as a toggleable option.

This could be shown similarly to how its done on the Lightning Jukebox:

Installation Issue

I seem to be having a issue with npm install.

root@BTCPayServerVM:/home/elementsprojects/nanopos# npm install
root@BTCPayServerVM:/home/elementsprojects/nanopos# npm start

[email protected] start /home/elementsprojects/nanopos
./start.sh

npm ERR! weird error 1
npm WARN This failure might be due to the use of legacy binary "node"
npm WARN For further explanations, please read
/usr/share/doc/nodejs/README.Debian

npm ERR! not ok code 0
root@BTCPayServerVM:/home/elementsprojects/nanopos# npm install
root@BTCPayServerVM:/home/elementsprojects/nanopos# npm start

[email protected] start /home/elementsprojects/nanopos
./start.sh

npm ERR! weird error 1
npm WARN This failure might be due to the use of legacy binary "node"
npm WARN For further explanations, please read
/usr/share/doc/nodejs/README.Debian

npm ERR! not ok code 0