59 lines
1.9 KiB
Markdown
59 lines
1.9 KiB
Markdown
---
|
|
layout: default
|
|
parent: For developers
|
|
title: Installation
|
|
nav_order: 1
|
|
---
|
|
|
|
# Installation
|
|
|
|
The application uses [Pipenv][pipenv] to manage Python packages.
|
|
While in development, you will need to install all dependencies:
|
|
|
|
```sh
|
|
git clone https://github.com/lnbits/lnbits-legend.git
|
|
cd lnbits-legend/
|
|
pipenv shell
|
|
# pipenv --python 3.8 shell (if you wish to use a version of Python higher than 3.7)
|
|
pipenv install --dev
|
|
# pipenv --python 3.8 install --dev (if you wish to use a version of Python higher than 3.7)
|
|
|
|
# If any of the modules fails to install, try checking and upgrading your setupTool module
|
|
# pip install -U setuptools
|
|
```
|
|
|
|
You will need to copy `.env.example` to `.env`, then set variables there.
|
|
|
|
|
|
|
|
You might also need to install additional packages, depending on the [backend wallet](../guide/wallets.md) you use.
|
|
E.g. when you want to use LND you have to `pipenv run pip install lndgrpc` and `pipenv run pip install purerpc`.
|
|
|
|
Take a look at [Polar][polar] for an excellent way of spinning up a Lightning Network dev environment.
|
|
|
|
## Running the server
|
|
|
|
LNbits uses [FastAPI][fastapi] as an application server.
|
|
Before running the server for the first time, make sure to create the data folder and edit the .env file:
|
|
|
|
mkdir data
|
|
cp .env.example .env
|
|
sudo nano .env
|
|
|
|
To then run the server, use:
|
|
|
|
pipenv run python -m uvicorn lnbits.__main__:app --reload
|
|
|
|
**Note**: We reccomend using <a href="https://caddyserver.com/docs/install#debian-ubuntu-raspbian">Caddy</a> for a reverse-proxy, if you want to serve your install through a domain, alternatively you can use [ngrok](https://ngrok.com/).
|
|
|
|
this will give you an _https_ tunnel for the _localhost_, use that URL for navigating to LNBits.
|
|
|
|
## Frontend
|
|
|
|
The frontend uses [Vue.js and Quasar][quasar].
|
|
|
|
[quart]: https://pgjones.gitlab.io/
|
|
[pipenv]: https://pipenv.pypa.io/
|
|
[polar]: https://lightningpolar.com/
|
|
[quasar]: https://quasar.dev/start/how-to-use-vue
|