lnbits/docs/devs/installation.md

1.3 KiB

layout parent title nav_order
default For developers Installation 1

Installation

Download the latest stable release https://github.com/lnbits/lnbits/releases

Application dependencies

The application uses Pipenv to manage Python packages. While in development, you will need to install all dependencies:

$ pipenv shell
$ pipenv install --dev

If you wish to use a version of Python higher than 3.7:

$ pipenv --python 3.8 install --dev

You will need to copy .env.example to .env, then set variables there.

Files

You might also need to install additional packages, depending on the backend wallet you use. E.g. when you want to use LND you have to pipenv run pip install lndgrpc and pipenv run pip install pureprc.

Take a look at Polar for an excellent way of spinning up a Lightning Network dev environment.

Running the server

LNbits uses Quart as an application server.

$ pipenv run python -m lnbits

Frontend

The frontend uses Vue.js and Quasar.