Link Search Menu Expand Document

Installation

Download this repo and install the dependencies.

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 set the variables in .env.example, and rename the file to .env.

Files

You might also need to install additional packages, depending on the backend wallets you configured. E.g. when you want to use LND you have to pipenv install lnd-grpc.

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

Running the server

LNbits uses Flask as an application server.

$ pipenv run flask migrate
$ pipenv run flask run

There is an environment variable called FLASK_ENV that has to be set to development if you want to run Flask in debug mode with autoreload

Frontend

The views are build using Vue.js and Quasar.