lnbits/docs/devs/installation.md
fiatjaf f01028eac7 migrate from flask to quart.
also remove all flaskiness from static file serving.
and reference all vendored scripts on the base tempĺate for simplicity.
2020-09-14 16:03:25 -03:00

1.3 KiB

layout parent title nav_order
default For developers Installation 1

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 wallet you use. E.g. when you want to use LND you have to pipenv run pip 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 Quart as an application server.

$ pipenv run python -m lnbits

Frontend

The frontend uses Vue.js and Quasar.