mirror of
https://github.com/lnbits/lnbits-legend.git
synced 2025-03-12 19:03:11 +01:00
65 lines
2 KiB
Markdown
65 lines
2 KiB
Markdown
---
|
|
layout: default
|
|
parent: For developers
|
|
title: Installation
|
|
nav_order: 1
|
|
---
|
|
|
|
# Installation
|
|
|
|
Download the latest stable release https://github.com/lnbits/lnbits/releases
|
|
|
|
## Application dependencies
|
|
|
|
The application uses [Pipenv][pipenv] to manage Python packages.
|
|
While in development, you will need to install all dependencies:
|
|
|
|
git clone https://github.com/lnbits/lnbits-legend.git
|
|
cd lnbits-legend/
|
|
# for now you'll need to `git checkout FastAPI`
|
|
pipenv shell
|
|
pipenv install --dev
|
|
|
|
If any of the modules fails to install, try checking and upgrading your setupTool module.
|
|
`pip install -U setuptools`
|
|
|
|
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.
|
|
|
|
|
|
|
|
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**: You'll need to use _https_ for some endpoints and/or extensions. You can use [ngrok](https://ngrok.com/) for that. Follow the installation instructions on the website and when it's all set you can run:
|
|
|
|
./nrok http 5000
|
|
|
|
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
|