chore: update install instructions for developers (#2652)

This commit is contained in:
Pavol Rusnak 2024-08-30 13:18:42 +02:00 committed by GitHub
parent 4732c4b296
commit 596167f443
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -11,13 +11,16 @@ Thanks for contributing :)
# Run
This starts the lnbits uvicorn server
Follow the [Basic installation: Option 1 (recommended): poetry](https://docs.lnbits.org/guide/installation.html#option-1-recommended-poetry)
guide to install poetry and other dependencies.
Then you can start LNbits uvicorn server with:
```bash
poetry run lnbits
```
This starts the lnbits uvicorn with hot reloading.
Or you can use the following to start uvicorn with hot reloading enabled:
```bash
make dev
@ -25,6 +28,15 @@ make dev
poetry run lnbits --reload
```
You might need the following extra dependencies on clean installation of Debian:
```
sudo apt install nodejs
sudo apt install npm
npm install
sudo apt-get install autoconf libtool libpg-dev
```
# Precommit hooks
This ensures that all commits adhere to the formatting and linting rules.